Generate static pages from all Markdown in a folder.

  ,,        ,,
  db      `7MM
            MM
`7MM   ,M""bMM  ,pW"Wq.   ,p6"bo
  MM ,AP    MM 6W'   `Wb 6M'  OO
  MM 8MI    MM 8M     M8 8M
  MM `Mb    MM YA.   ,A9 YM.    ,
.JMML.`Wbmd"MML.`Ybmd9'   YMbmd'

Quick Start

Create a idoc site using the beautiful defalut theme.

$ npx idoc init myapp

Or

$ sudo npm i idoc -g
$ idoc init myapp

Running the idoc init myapp generator from the command line will create a directory structure with the following elements:

├── docs
│   ├── README.md
│   └── about.md
├── package.json
└── idoc.yml

Command Help

Usage: idoc [init|new][options] [--help|h] [--version|v]

Options:

  -v, --version, Show version number
  -h, --help, Displays help information.
  -f, --force, Force file regeneration.
  -d, --dir <dir-path>, Markdown file directory. defalut(docs)
  -o, --output <dir-path>, Output directory. defalut(dist)
  -w, --watch, Watch and compile Markdown files.
  -t, --theme, Customize theme settings. defalut(defalut)
  -m, --minify, minify HTML

Example:

  npm idoc init <folder>
  npm idoc new introduce/README.md
  npm idoc new introduce/README.md "Hello World" -f
  npm idoc --theme="defalut"
  npm idoc --dir="docs"
  npm idoc --output="dist"
  npm idoc --watch --output="www"

Compiled with idoc

Repo	Starred	Website
Awesome Mac		Preview Website
MySQL Tutorial		Preview Website
Docker Tutorial		Preview Website
Nginx Tutorial		Preview Website
Vim Web		Preview Website
Git Tips		Preview Website
Awesome UIKit		Preview Website
Shell Tutorial		Preview Website
SwiftUI Example		Preview Website
Swift Tutorial		Preview Website
Handbook		Preview Website
GitHub Actions		Preview Website
HTML Tutorial		Preview Website
C Tutorial		Preview Website

Contributors

As always, thanks to our amazing contributors!

Made with action-contributors.

License

Licensed under the MIT License.