Home

Tutorials

Fundamentals

1. How jsdoc2md works
2. Document a CommonJS module
3. Document a ES2015 module
4. Document a AMD module
5. Document ES2016 features like async and await
6. Listing namepaths

Customising output

1. Simple example: create a project README.md
2. Create a plugin
3. Existing plugin list

Task runners

1. Use with npm run
2. Use with Gulp
3. Use with grunt

Scripting

1. Create one output file per class

Tag Conventions

1. Give your module, class or namespace a @typicalname.
2. Promises (@fulfil and @reject)
3. Todo lists (@todo and @done)
4. Linking to external resources (using @external and @see)
5. @chainable
6. Custom tags

FAQ

• Why am I getting errors?

  As a general rule, if it works in jsdoc it will work in jsdoc2md. Test your source with jsdoc -X my-code.js - if that fails it will fail in jsdoc2md too.

• I still have questions...

  Post your question in the jsdoc2md chat room, i'll get back to you as soon as I can!