egg-doctools
v2.9.1
Published
Doctools for Egg.js
Downloads
237
Maintainers
Keywords
Readme
Doctools for Egg.js
Feature
- Document generator using hexo
- API document generator using jsdoc
- Deploy to gh-pages
- Local development
- Theme for Egg.js
Usage
Installation
npm i egg-doctools --save-dev
Only support egg framework, see structure below
|- index.js
|- docs
| |- source
| | |- _data
| | | |- guide_toc.yml <- toc links
| | | `- menu.yml <- menu links
| | |- en <- english document
| | `- zh-cn <- chinese document
| `- _config.yml <- hexo config
`- package.json
Run doctools build
to generate document to ${baseDir}/run/doctools
.
Commands
doctools build
: build documentdoctools server
: local developmentdoctools deploy
: deploy to gh-pages