README.zh_CN.md

DocMan - Node.js 文档站点构造系统

DocMan 是一款基于 Node.js 的文档站点构造系统，允许您将由 Markdown 编写的文档项目（文档、教程、笔记等等）出版为可以在浏览器中给用户阅读的 HTML 文档站点。

相关链接 / 参与贡献

• 官方文档：DocMan Docs
• DocMan Core（本项目）：GitHub | Gitee | NPM
• DocMan CLI：GitHub | Gitee | NPM

快速开始

安装 DocMan CLI ：

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

创建 DocMan 实例：

$ docman create hello-world

进入 DocMan 实例，安装 NPM 依赖，然后开始构建：

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

构造得到的 HTML 站点文件将会输出至 DocMan 实例的 dist 目录下，您可以使用 Web 服务器进行发布。