apidoc-lite
this zero-dependency package will auto-generate documentation for your npm-package with zero-config
live web demo
git-branch : | master | beta | alpha |
---|---|---|---|
test-report : | |||
coverage : | |||
build-artifacts : |
table of contents
- cdn download
- documentation
- quickstart shell example
- extra screenshots
- package.json
- changelog of last 50 commits
- internal build script
- misc
cdn download
documentation
api doc
cli help
changelog 2020.6.8
- npm publish 2020.6.8
- remove electron-dependency
- remove eagerly requiring nodejs-builtins
- migrate ci from travis-ci.org to travis-ci.com
- istanbul - fix html-coverage-report bug showing branch-metrics instead of line-metrics
- none
todo
-none
this package requires
- darwin or linux os
quickstart shell example
to run this example, follow the instruction in the script below
# example.sh # this shell script will auto-generate documentation for the mysql npm-package with zero-config # 1. npm install apidoc-lite npm install apidoc-lite --prefix .# 2. npm install mysql npm install mysql# 3. auto-generate documentation for the mysql npm-package with zero-config ./node_modules/.bin/apidoc-lite mysql > /tmp/apidoc.html# 4. open /tmp/apidoc.html to view the auto-generated mysql documentation
output from browser
output from shell
extra screenshots
-
https://kaizhu256.github.io/node-apidoc-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fapidoc.html.png
-
https://kaizhu256.github.io/node-apidoc-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fcoverage.lib.html.png
-
https://kaizhu256.github.io/node-apidoc-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Ftest-report.html.png
package.json
changelog of last 50 commits
internal build script
- build_ci.sh
# build_ci.sh # this shell script will run build-ci for this package # run shBuildCi eval "$(utility2 source)"shBuildCi
misc
- this package was created with utility2