apidocs-cli
Command-line app for generating API docs from code comments. Can be used as API of helper-apidocs package.
Install
npm i apidocs-cli --global
or use it as module, not as cli
npm i apidocs-cli --save
Usage
For more use-cases see the tests
apidocsCli
Generate API docs from code comments in the JavaScript files that match the given
patterns
. Only code comments with@api public
are rendered.
Params
<files>
{String} filepath(s) or glob pattern(s)[options]
{Object} options to pass to [helper-apidocs][apidocs] orcallback
<callback>
{Function} node-style callback function(err, res)
Example
const apidocsCli =
.sync
Synchronous generating API Docs.
Params
<files>
{String} filepath(s) or glob pattern(s)[options]
{Object} options to pass to [helper-apidocs][apidocs]
Example
const apidocsCli = const docs = apidocsCli console//=> markdown formatted documentation of// all .js files in repo root (index.js and test.js)
CLI
run
apidocs --help
Command-line app for generating API docs from code comments.
Can be used as API of `helper-apidocs` package.
Options (plus any options introduced in helper-apidocs)
--help show this help
--version current version
Usage
apidocs <FILES...> [flags]
Example
apidocs index.js
apidocs ./lib/*.js
Issues: https://github.com/tunnckoCore/apidocs-cli/issues
Readme: https://github.com/tunnckoCore/apidocs-cli
Helper: https://github.com/helpers/helper-apidocs
Related
- gitclone-cli: Git clone github repository with pattern like
user/repo#branch
- helper-apidocs: Template helper for automatically generating API docs from code comments. Should work with any template engine.
- is-installed: Checks that given package is installed on the system - globally or locally.
- is-missing: Check that given
name
oruser/repo
exists in npm registry or in github as user repository. - parse-function: Parse a function, arrow function or string to object with name, args, params and body properties.
- parse-github-short-url: Parse a github/npm shorthand (user/repo#branch or user/repo@version) URL into an object.
- parse-github-url: Parse a github URL into an object.
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.