## 安装

1. npm install apidoc -g # 安装apidoc命令
2. npm install apidoc-markdown -g # 安装生成markdown的命令

## 命令

// apidoc -i 指定读取源文件的目录 -o 指定输出HTML文档的目录
apidoc -i src/controller -o src/public/docs

// apidoc-markdown -p 已生成HTML文档的目录 -o 指定输出的markdown文件
apidoc-markdown -p src/public/docs -o src/public/docs/api.md

## 配置文件

src/apidoc.json
`{
  "name": "文档名称",
  "version": "0.1.0",
  "description": "文档说明",
  "title": "文档标题-HTML的title",
  "sampleUrl": "http://localhost",
  "template": {
    "withCompare": true,
    "withGenerator": true,
    "aloneDisplay": false
  }
}`

## 格式参考

https://www.jianshu.com/p/9353d5cc1ef8