idoc === [](https://npmjs.org/package/idoc) [](https://github.com/jaywcjlove/idoc/actions/workflows/ci.yml) [](https://github.com/jaywcjlove/idoc/network/dependents) [](https://www.npmjs.com/package/idoc) [](https://www.npmjs.com/package/idoc) [](https://www.npmjs.com/package/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 ``` ## 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. -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: npm idoc init 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 | Last Commit | Website | | ---- | ---- | ---- | ---- | | [Awesome Mac](https://github.com/jaywcjlove/awesome-mac) | [](https://github.com/jaywcjlove/awesome-mac/stargazers) | [](https://github.com/jaywcjlove/awesome-mac/commits) | [Preview Website](https://jaywcjlove.github.io/awesome-mac) | | [MySQL Tutorial](https://github.com/jaywcjlove/mysql-tutorial) | [](https://github.com/jaywcjlove/mysql-tutorial/stargazers) | [](https://github.com/jaywcjlove/mysql-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/mysql-tutorial) | | [Docker Tutorial](https://github.com/jaywcjlove/docker-tutorial) | [](https://github.com/jaywcjlove/docker-tutorial/stargazers) | [](https://github.com/jaywcjlove/docker-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/docker-tutorial) | | [Nginx Tutorial](https://github.com/jaywcjlove/nginx-tutorial) | [](https://github.com/jaywcjlove/nginx-tutorial/stargazers) | [](https://github.com/jaywcjlove/nginx-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/nginx-tutorial) | | [Vim Web](https://github.com/jaywcjlove/vim-web) | [](https://github.com/jaywcjlove/vim-web/stargazers) | [](https://github.com/jaywcjlove/vim-web/commits) | [Preview Website](https://jaywcjlove.github.io/vim-web) | | [Git Tips](https://github.com/jaywcjlove/git-tips) | [](https://github.com/jaywcjlove/git-tips/stargazers) | [](https://github.com/jaywcjlove/git-tips/commits) | [Preview Website](https://jaywcjlove.github.io/git-tips) | | [Awesome UIKit](https://github.com/jaywcjlove/shell-tutorialawesome-uikit) | [](https://github.com/jaywcjlove/awesome-uikit/stargazers) | [](https://github.com/jaywcjlove/awesome-uikit/commits) | [Preview Website](https://jaywcjlove.github.io/awesome-uikit) | | [Shell Tutorial](https://github.com/jaywcjlove/shell-tutorial) | [](https://github.com/jaywcjlove/shell-tutorial/stargazers) | [](https://github.com/jaywcjlove/shell-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/shell-tutorial) | | [SwiftUI Example](https://github.com/jaywcjlove/swiftui-example) | [](https://github.com/jaywcjlove/swiftui-example/stargazers) | [](https://github.com/jaywcjlove/swiftui-example/commits) | [Preview Website](https://jaywcjlove.github.io/swiftui-example) | | [Swift Tutorial](https://github.com/jaywcjlove/swift-tutorial) | [](https://github.com/jaywcjlove/swift-tutorial/stargazers) | [](https://github.com/jaywcjlove/swift-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/swift-tutorial) | | [Handbook](https://github.com/jaywcjlove/handbook) | [](https://github.com/jaywcjlove/handbook/stargazers) | [](https://github.com/jaywcjlove/handbook/commits) | [Preview Website](https://jaywcjlove.github.io/handbook) | | [GitHub Actions](https://github.com/jaywcjlove/github-actions) | [](https://github.com/jaywcjlove/github-actions/stargazers) | [](https://github.com/jaywcjlove/github-actions/commits) | [Preview Website](https://jaywcjlove.github.io/github-actions) | | [HTML Tutorial](https://github.com/jaywcjlove/html-tutorial) | [](https://github.com/jaywcjlove/html-tutorial/stargazers) | [](https://github.com/jaywcjlove/html-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/html-tutorial) | | [C Tutorial](https://github.com/jaywcjlove/c-tutorial) | [](https://github.com/jaywcjlove/c-tutorial/stargazers) | [](https://github.com/jaywcjlove/c-tutorial/commits) | [Preview Website](https://jaywcjlove.github.io/c-tutorial) | | [React Native](https://github.com/jaywcjlove/react-native) | [](https://github.com/jaywcjlove/react-native/stargazers) | [](https://github.com/jaywcjlove/react-native/commits) | [Preview Website](https://jaywcjlove.github.io/react-native) | ## Contributors As always, thanks to our amazing contributors! Made with [action-contributors](https://github.com/jaywcjlove/github-action-contributors). ## License Licensed under the MIT License.