Simple cli tool to inject jsdoc result into README.md files.
The tools looks for a <!-- api -->
tag in the README and inject generated JSDoc markdown at this location. Usefull for small libraries where creating a full API website is cumbersome.
The tool is a simple wrapper around the documentation.js package, using the same idea as the markdown-toc package.
npm install --save-dev jsdoc-to-readme
Usage: jsdoc-to-readme [options]
--src: The source files to parse using `jsdoc-to-mardown`
--output: The mardown file in which injecting the documentation
at <!-- api --> (defaults to README.md)
--heading-depth: The title level of the generated documentation
(defaults to 3)
--tag: The tag to be used, default to 'api'
The tool has been developped to play well with markdown-toc. To simply create README files that contain both a table of content and API documentation.
npm install --save-dev jsdoc-to-readme markdown-toc
"scripts": {
"api": "jsdoc-to-readme --src src/index.js",
"toc": "markdown-toc -i README.md --maxdepth 3",
"doc": "npm run api && npm run toc",
// ...
}
caveat: the markdown-toc
option --maxdepth
is set to 3, which is the level at which jsdoc-to-readme
starts to create titles by default. This is needed to prevent some confusions in the way the toc is being processed and avoid broken links in the toc.
# My-lib
> Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.
## Table of Contents
<!-- toc -->
## Install
// ...
## API
<!-- api -->
## MISC
npm run doc
BSD-3-Clause