Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

apidoc-lite

2020.6.8 • Public • Published

apidoc-lite

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

live web demo

screenshot

travis-ci.com build-status coverage

NPM

build commit status

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

npmPackageListing

npmPackageDependencyTree

table of contents

  1. cdn download
  2. documentation
  3. quickstart shell example
  4. extra screenshots
  5. package.json
  6. changelog of last 50 commits
  7. internal build script
  8. misc

cdn download

documentation

api doc

apidoc

cli help

screenshot

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

screenshot

output from shell

screenshot

extra screenshots

  1. https://kaizhu256.github.io/node-apidoc-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fapidoc.html.png screenshot

  2. https://kaizhu256.github.io/node-apidoc-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fcoverage.lib.html.png screenshot

  3. https://kaizhu256.github.io/node-apidoc-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Ftest-report.html.png screenshot

package.json

{
    "author": "kai zhu <kaizhu256@gmail.com>",
    "bin": {
        "apidoc-lite": "lib.apidoc.js"
    },
    "description": "this zero-dependency package will auto-generate documentation for your npm-package with zero-config",
    "devDependencies": {
        "utility2": "kaizhu256/node-utility2#alpha"
    },
    "engines": {
        "node": ">=12.0"
    },
    "fileCount": 8,
    "homepage": "https://github.com/kaizhu256/node-apidoc-lite",
    "keywords": [
        "apidoc",
        "documentation-generator",
        "doxygen"
    ],
    "license": "MIT",
    "main": "lib.apidoc.js",
    "name": "apidoc-lite",
    "nameAliasPublish": "npmdoc",
    "nameLib": "apidoc",
    "nameOriginal": "apidoc-lite",
    "os": [
        "darwin",
        "linux"
    ],
    "repository": {
        "type": "git",
        "url": "https://github.com/kaizhu256/node-apidoc-lite.git"
    },
    "scripts": {
        "build-ci": "./npm_scripts.sh",
        "env": "env",
        "eval": "./npm_scripts.sh",
        "heroku-postbuild": "./npm_scripts.sh",
        "postinstall": "./npm_scripts.sh",
        "start": "./npm_scripts.sh",
        "test": "./npm_scripts.sh",
        "utility2": "./npm_scripts.sh"
    },
    "version": "2020.6.8"
}

changelog of last 50 commits

screenshot

internal build script

  • build_ci.sh
# build_ci.sh 
 
# this shell script will run build-ci for this package 
 
shBuildCiAfter () {(set -e
    shDeployCustom
    # shDeployGithub 
    # shDeployHeroku 
    # bug-workaround for "npm install [package name] removes packages" 
    # https://github.com/npm/npm/issues/17379 
    # https://github.com/travis-ci/travis-ci/issues/4653#issuecomment-379397837 
    if [ "$TRAVIS" ] && (dpkg --compare-versions "$(npm -v)" lt 5.8)
    then
         npm i -g npm@5.8
    fi
    shReadmeTest example.sh
    # screenshot 
    MODE_BUILD=testExampleSh shBrowserScreenshot file:///tmp/apidoc.html
    cp /tmp/apidoc.html "$npm_config_dir_build/apidoc.example.html"
)}
 
shBuildCiBefore () {(set -e
    shNpmTestPublished
    shReadmeTest example.js
)}
 
# run shBuildCi 
eval "$(utility2 source)"
shBuildCi

misc

  • this package was created with utility2

Install

npm i apidoc-lite

DownloadsWeekly Downloads

21

Version

2020.6.8

License

MIT

Unpacked Size

63 kB

Total Files

6

Last publish

Collaborators

  • avatar