Awesome

docme

Generates github compatible API documentation from your project's jsdocs and adds them to your Readme.

Installation

npm install docme

Usage

docme <readme> <docme-options> -- <jsdoc-options>

  Generates jsdocs for non-private members of the project in the current folder.
  It then updates the given README with the githubified version of the generated API docs.

  Note: overriding the jsdoc destination (-d, --destination) is not possible since docme will write files to a temp dir

OPTIONS:

  -l, --loglevel  level at which to log: silly|verbose|info|warn|error|silent -- default: info
  
  -h, --help      Print this help message.

EXAMPLES:
  
  Generate with default options and update README.md
    
    docme README.md

  Override [jsdocconf.json](http://usejsdoc.org/about-configuring-jsdoc.html):

    docme README.md -- --configure ./myconf.json

  Override loglevel and jsoc configuration:

    docme API.md --loglevel silly -- --configure ./myconf.json

Note: all functions that are not part of the public API should be marked as @private in order to exclude them from the docs generated by docme.

Helpful links

Since docme is using jsdoc under the hood, it is helpful to review its documentation. I highly recommend this page explaining how to specify @param types among other useful specs.

In order to make your docme APIs appear properly styled, please install the chrome extension or bookmarklet.

API

<div> <div class="jsdoc-githubify"> <section> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <dl> <dt> <h4 class="name" id="docme"><span class="type-signature"></span>docme<span class="signature">(readme, args, jsdocargs, cb)</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> <p>Generates jsdocs for non-private members of the project in the current folder. It then updates the given README with the githubified version of the generated API docs.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>readme</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>path to readme in which the API docs should be updated</p></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">Array.<String></span> </td> <td class="description last"><p>consumed by docme</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>loglevel</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>(info) level at which to log: silly|verbose|info|warn|error|silent</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>jsdocargs</code></td> <td class="type"> <span class="param-type">Array.<String></span> </td> <td class="description last"><p>consumed by jsdoc</p></td> </tr> <tr> <td class="name"><code>cb</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>called back when docme finished updating the README</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"> <li> <a href="https://github.com/thlorenz/docme/blob/master/index.js">index.js</a> <span>, </span> <a href="https://github.com/thlorenz/docme/blob/master/index.js#L54">lineno 54</a> </li> </ul></dd> </dl> </article> </section> </div>

generated with docme

</div>

License

MIT