Home - jsdoc2md/jsdoc-to-markdown GitHub Wiki

Tutorials

Fundamentals

  1. Some real world examples
  2. Document a CommonJS module
    1. Using module exports
    2. Using exports
  3. Document an ES2015 module
    1. Single default export
    2. Multiple named exports
  4. Document an AMD module
  5. Document ES2017 features like async and await
  6. Document TypeScript
  7. Listing namepaths
  8. Documenting .mjs, .jsx or files with any other extension

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

Format options

  1. @param list formats - table and list.
  2. @property list formats - table and list.
  3. Member index formats
  4. Module index formats
  5. Global index formats
  6. Output standard markdown (rather than Github-flavoured)
  7. Initial heading depth
  8. Default @example language

Customising output

  1. --template example: create a project README.md
  2. --partial example: tweak the output with a custom partial
  3. --helper example: register custom helpers for use in your template
  4. Cherry-picking which documentation appears in output
  5. Create a plugin
  6. 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

Internals

  1. How jsdoc2md works

Troubleshooting

First, check the troubleshooting page. If still have questions, post your question in an issue or the jsdoc2md chat room, i'll get back to you as soon as I can!