idoc

idoc
===


Generate static pages from all Markdown in a folder.

``bash
,, ,,
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.

`bash
$ npx idoc init myapp
`

Or

`bash
$ 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:

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

Or use in github actions

`yml
- name: Create idoc config.
run: |
cat > idoc.yml << EOF
site: "Rehype Rewrite {{version}}"
menus:
Home: index.html
EOF

- run: npm install idoc@1.26.6 -g
- run: idoc --output="www"
`

Command Help

`bash
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.
-s, --site, Set website name.
-d, --dir , Markdown file directory. defalut(docs)
-o, --output , Output directory. defalut(dist)
-w, --watch, Watch and compile Markdown files.
-t, --theme, Customize theme settings. defalut(defalut)
-m, --minify, minify HTML

Example:

$ idoc init
$ idoc new introduce/README.md
$ idoc new introduce/README.md "Hello World" -f
$ idoc --theme="defalut"
$ idoc --dir="docs"
$ idoc --output="dist"
$ idoc --watch --output="www"
``

Compiled with idoc

My macOS app's official website is also built with it:

| Repo | Starred | Last Commit | Website |
| ---- | ---- | ---- | ---- |
| Awesome Mac |  |  | Preview Website |
| Awesome UIKit |  |  | Preview Website |
| MySQL Tutorial |  |  | Preview Website |
| Docker Tutorial |  |  | Preview Website |
| Nginx Tutorial |  |  | Preview Website |
| Vim Web |  |  | Preview Website |
| Git Tips |  |  | 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 |
| React Native |  |  | Preview Website |
| TypeNexus |  |  | Preview Website |
| Awesome ChatGPT |  |  | Preview Website |
| React Components Awesome |  |  | Preview Website |
| Repo | Starred | Downloads | Website |
| rehype-rewrite |  |  | Preview Website |
| rehype-attr |  |  | Preview Website |
| rehype-ignore |  |  | Preview Website |
| rehype-video |  |  | Preview Website |
| remark-github-blockquote-alert |  |  | Preview Website |
| store.js |  |  | Preview Website |
| cookie.js |  |  | Preview Website |
| auto-config-loader |  |  | Preview Website |
| chmod-cli |  |  | Preview Website |
| local-ip-url |  |  | Preview Website |
| path-templater |  |  | Preview Website |
| html-to-markdown-cli |  |  | Preview Website |
| colors-named |  |  | Preview Website |
| colors-named-hex |  |  | Preview Website |
| colors-named-decimal |  |  | Preview Website |
| chinese-numerals |  |  | Preview Website |
| image2uri |  |  | Preview Website |
| svgtofont |  |  | Preview Website |
| console-emojis |  |  | Preview Website |
| compile-less |  |  | Preview Website |

Contributors

As always, thanks to our amazing contributors!

Made with action-contributors.

License

Licensed under the MIT License.