Skip to content

Latest commit

 

History

20 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

marked-doc

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

NPM version


Install

下载到本地,在根目录执行:

npm install

或者,也可通过npm全局安装:

npm install marked-doc -g

Usage

本地使用

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

$ node doc 

全局使用

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

$ mddoc

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

生成文档效果


Todo

  1. 加入Commander全局命令

  2. 兼容linux与mac os

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

  4. 前端模板更换与定制

About

Doc build tool with markdown, based on marked

Resources

Stars

4 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages