marked-doc

> 文档自由书写方案，基于Node.js、marked，目前仅支持windows os

![NPM version][badge]

--------

Install

下载到本地，在根目录执行：

``

bash

npm install





或者，也可通过npm全局安装：

bash

npm install marked-doc -g





--------



Usage



$3



在当前目录下的'mds'子目录置入所有md文件，支持子目录嵌套

bash

$ node doc





$3



在当前目录下的'mds'子目录置入所有md文件，支持子目录嵌套

bash

$ mddoc

``

两者均将在当前目录下的'html'子目录（如没有将自动创建）下将自动生成文档和对应资源

生成文档效果

--------

1. 加入Commander全局命令

1. 兼容linux与mac os

2. 自定义输出路径等常用配置

3. 前端模板更换与定制

[badge]: https://www.npmjs.com/package/marked-doc

> 文档自由书写方案，基于Node.js、marked，目前仅支持windows os

![NPM version][badge]

--------

下载到本地，在根目录执行：

``

bash

npm install





或者，也可通过npm全局安装：

bash

npm install marked-doc -g





--------



Usage



$3



在当前目录下的'mds'子目录置入所有md文件，支持子目录嵌套

bash

$ node doc





$3



在当前目录下的'mds'子目录置入所有md文件，支持子目录嵌套

bash

$ mddoc

``

两者均将在当前目录下的'html'子目录（如没有将自动创建）下将自动生成文档和对应资源

生成文档效果

--------

1. 加入Commander全局命令

1. 兼容linux与mac os

2. 自定义输出路径等常用配置

3. 前端模板更换与定制

[badge]: https://www.npmjs.com/package/marked-doc