README.md

DocMan - Docs Website Build System Based on Node.js

DocMan is a documentation website build system based on Node.js, allow you publish your markdown document project (docs, tutorial, notes, etc.) as html website that users can read in a broswer.

Links / Contribute

• Our website: DocMan Docs
• DocMan Core (this project): GitHub | Gitee | NPM
• DocMan CLI: GitHub | Gitee | NPM

Quick Start

Install DocMan CLI.

$ npm install docman-cli -g
$ docman --help

Create a DocMan instance.

$ docman create hello-world

Enter DocMan instance, install dependencies, then start build.

$ cd hello-world
$ npm install
$ npm run build

The builded html website will output to dist sub directory in DocMan instance, now you can publish it by a web server.