apidoc-lite
===========
this zero-dependency package will auto-generate documentation for your npm-package with zero-config

 



documentation

#### apidoc
- https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/apidoc.html


#### todo
- none

#### change since dfed6414
- npm publish 2017.3.9
- add ability to create markdown documentation
- auto-document dir ./lib/
- increase auto-coverage of examples
- none

#### this package requires
- darwin or linux os

build status 


| git-branch : | master | beta | alpha|
|--:|:--|:--|:--|
| test-report : |  |  | |
| coverage : |  |  | |
| build-artifacts : |  |  | |

#### master branch
- stable branch
- HEAD should be tagged, npm-published package

#### beta branch
- semi-stable branch
- HEAD should be latest, npm-published package

#### alpha branch
- unstable branch
- HEAD is arbitrary
- commit history may be rewritten

quickstart shell example

#### to run this example, follow the instruction in the script below
- example.sh
``shell

example.sh

this shell script will auto-generate documentation for the mysql npm-package with zero-config

instruction

# 1. copy and paste this entire shell script into a console and press enter
# 2. open /tmp/apidoc.html to view the auto-generated documentation

shExampleSh() {(set -e
# npm install apidoc-lite
npm install apidoc-lite
# npm install mysql
npm install mysql
# auto-generate documentation for the mysql npm-package with zero-config
node_modules/.bin/apidoc-lite mysql > /tmp/apidoc.html
)}
shExampleSh
`

#### output from browser
![screen-capture](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/apidoc.example.html)

#### output from shell
!screen-capture

package.json


`json
{
"author": "kai zhu ",
"bin": {
"apidoc-lite": "lib.apidoc.js"
},
"description": "this zero-dependency package will auto-generate documentation for your npm-package with zero-config",
"devDependencies": {
"electron-lite": "kaizhu256/node-electron-lite#alpha",
"utility2": "kaizhu256/node-utility2#alpha"
},
"engines": {
"node": ">=4.0"
},
"homepage": "https://github.com/kaizhu256/node-apidoc-lite",
"keywords": [
"api-doc",
"apidoc",
"doc",
"documentation",
"doxygen",
"javadoc"
],
"license": "MIT",
"main": "lib.apidoc.js",
"name": "apidoc-lite",
"nameAlias": "apidoc",
"nameOriginal": "apidoc-lite",
"os": [
"darwin",
"linux"
],
"readmeParse": "1",
"repository": {
"type": "git",
"url": "https://github.com/kaizhu256/node-apidoc-lite.git"
},
"scripts": {
"build-ci": "utility2 shReadmeTest build_ci.sh",
"env": "env",
"heroku-postbuild": "npm install 'kaizhu256/node-utility2#alpha' && utility2 shDeployHeroku",
"postinstall": "if [ -f lib.apidoc.npm_scripts.sh ]; then ./lib.apidoc.npm_scripts.sh postinstall; fi",
"publish-alias": "VERSION=$(npm info $npm_package_name version); for ALIAS in api_doc apidocs api-doctor doctor-api npm-doc npmdoc; do utility2 shNpmPublishAs . $ALIAS $VERSION; utility2 shNpmTestPublished $ALIAS || exit $?; done",
"start": "export PORT=${PORT:-8080} && export npm_config_mode_auto_restart=1 && utility2 start",
"test": "export PORT=$(utility2 shServerPortRandom) && utility2 test test.js"
},
"version": "2017.3.9"
}
`

changelog of last 50 commits


internal build-script

- build_ci.sh
`shell

build_ci.sh

this shell script will run the build for this package

shBuildCiInternalPost() {(set -e
shReadmeBuildLinkVerify
)}

shBuildCiInternalPre() {(set -e
shReadmeTest example.js
shReadmeTest example.sh
# save screen-capture
(export MODE_BUILD=testExampleSh &&
export url=/tmp/apidoc.html &&
utility2 shBrowserTest &&
cp /tmp/apidoc.html "$npm_config_dir_build/apidoc.example.html") || return $?
shNpmTestPublished
)}

shBuildCiPost() {(set -e
return
)}

shBuildCiPre() {(set -e
return
)}

init env

eval $(utility2 source) && shBuildCi
``

misc

- this package was created with utility2