egg-doctools

Doctools for Egg.js

Usage no npm install needed!

<script type="module">
  import eggDoctools from 'https://cdn.skypack.dev/egg-doctools';
</script>

README

Doctools for Egg.js

NPM version build status Test coverage David deps Known Vulnerabilities NPM download

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 document
  • doctools server: local development
  • doctools deploy: deploy to gh-pages

License

MIT