Downloads NPM version Build

Generate static pages from all Markdown in a folder.

  ,,        ,,
  db      `7MM
`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


$ 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
│   ├──
│   └──
├── package.json
└── idoc.yml

Command Help

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


  -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)


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


As always, thanks to our amazing contributors!

Made with action-contributors.


Licensed under the MIT License.