/JsDocTemplate

Primary LanguageHTML

JsDocTemplate

A template based on Docdash by clenemtA for JSDoc 3.

docdash-screenshot

Difference

  • Different color scheme (purple => blue)
  • Rewritten code to ES6
  • Updated to latest version of prettify (distrib => commit b5fa4d1 on 5 Mar 2019)
  • Optimized color scheme for prettify
  • Minified version available

Live Example

https://cosmoledo.github.io/JsDocTemplate/example_out/

Install

  • Download this repository
  • Extract the dist-folder to any path
  • Rename the dist-folder to "JsDocTemplate"

To install it global:

  • Move the folder to "C:\Users\USERNAME\AppData\Roaming\npm\node_modules\jsdoc\templates"
  • Set in your jsdoc-config-file "opts.template" to "templates/JsDocTemplate"

To install it for a local project:

  • Move the folder to your project dir
  • Set in your jsdoc-config-file "opts.template" to "JsDocTemplate"

HINT: Path to JsDocTemplate-folder has to be relative to the config-file

Usage

$ jsdoc entry-file.js -t templates/JsDocTemplate

Sample jsdoc.json

JsDocTemplate is based on Docdash, so it supports the same config options.

Options

JsDocTemplate is based on Docdash, so it supports the same options.

Important:

The options are not stored in the "docdash"-keyword, you have to use "jsdoctemplate" instead.