Home

JSDoc Template CI

This is a demo for a decent template for JSDoc.

Use this template

You can use this template in your projects too, just install it via NPM:

NPM
# npm install jsdoc -g
# npm install @alexispuga/jsdoc-template
jsdoc your/files -t ./node_modules/@alexispuga/jsdoc-template

Personalize it

Make this template yours without forking this repository:

  • Create a jsdoc.config.js file.
  • Modify it (see all supported properties).
  • Load it from jsdoc: jsdoc your/files -t this/template -c your/jsdoc.config.js.

...and, that's it. Thank you!

Now you can just test this nonsense demo or check this repository on github.

THIS IS A DEMO: All content was generated with examples taken from the JSDoc page.