node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org ยป

jsdoc-readme

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.