2.9.1 • Published 4 years ago
egg-doctools v2.9.1
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
License
2.9.1
4 years ago
2.9.0
5 years ago
2.8.5
5 years ago
2.8.4
5 years ago
2.8.3
5 years ago
2.8.2
5 years ago
2.8.1
5 years ago
2.8.0
5 years ago
2.7.4
5 years ago
2.7.2
5 years ago
2.7.1
5 years ago
2.7.0
6 years ago
2.6.0
6 years ago
2.5.0
6 years ago
2.4.0
6 years ago
2.3.1
6 years ago
2.3.0
6 years ago
2.2.1
6 years ago
2.2.0
6 years ago
2.1.1
6 years ago
2.1.0
7 years ago
2.0.1
7 years ago
2.0.0
7 years ago
1.2.3
7 years ago
1.2.2
7 years ago
1.2.1
7 years ago
1.2.0
7 years ago
1.1.4
7 years ago
1.1.3
7 years ago
1.1.2
7 years ago
1.1.1
7 years ago
1.1.0
7 years ago
1.0.0
7 years ago