Exemplary APIs

Links to generated examples.

Generated README Examples

These examples all generate custom README files, passing a handlebars template to --template.

Project	Notes
handbrake-js	A module exposing two methods and an inner class. Demonstrates documenting events, linked types and use of @external combined with @see.The API docs are inserted into this README template by this command: $ jsdoc2md --template jsdoc2md/README.hbs lib/*.js
command-line-args	Demonstrates documentation of a @module exporting a ES2015 class, the @typicalname, @throws and @alias tags.
array-tools	Very simple module exporting a collection of static methods. Demonstrates use of @example and @category to group identifiers in the member-list.
jesucarr/tokenbucket	Demonstrates --param-list-format list and the documentation of Promises using the @fulfil and @reject tags.
ansi-escape-sequences	Demonstrates usage of @enum {type} (rendered in table format).

In the wild

Feel free to send me a link to your docs.

• EmergingTechnologyAdvisors/node-serialport
• apache/cordova-plugin-camera (customised)
• Polymer/polymer-analyzer
• Google/eddystone
• websockets/ws
• wikimedia/node-rdkafka
• noodlefrenzy/node-amqp10 (massive, tables, ascii diagrams)
• IBM-Bluemix/gp-js-client
• alexmingoia/koa-router
• IjzerenHein/famous-map
• devicehive/devicehive-javascript
• dc-js/dc.js (massive)
• alexindigo/multibundle-mapper (use of --private)
• AndyOGo/gulp-pilot (uses @example captions and custom tags)