jsdoc-readme

JsDoc Readme Generator. Pulls a Node.js's main library's Constructor's jsdoc markdown, then puts it into README.md

npm install jsdoc-readme
1 downloads in the last week
5 downloads in the last month

jsdoc-readme

Automatically generate README.md documentation with jsdoc-style comments.

How To Use

  1. $ npm install -g jsdoc-readme
  2. $ cd /path/to/your/node/project
  3. $ jsdoc-readme

Voila! The content of your node project's main library's jsdoc-style constructor description block is copied into the current directory's README.md file.

How It Works

  1. Checks package.json for the main library path.
  2. Get contents of the main constructor's jsdoc description block.
  3. Put contents into current directory's README.md.
npm loves you