JSDoc theme based on Namis, based Minami
npm install sutro-jsdoc-themeA clean, responsive, documentation template theme for JSDoc 3.
Based on Namis, which is based on
based on Minami.
- Source Sans Pro and Source Code Pro typefaces by Adobe.
- the Taffy Database library
- Underscore Template library
``bash`
$ npm install --save-dev sutro-jsdoc-theme
`bash`
$ jsdoc entry-file.js -t node_modules/sutro-jsdoc-theme
You can customize the template in your jsdoc.conf.json file:`json`
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"source": {
"include": "./src/",
"includePattern": ".+\\.js$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [
"plugins/markdown"
],
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"linenums": true,
"includeDate": false,
"title": "MathLive",
"pageTitle": "MathLive Docs",
"description": "Beautifully typeset math made easy",
"keywords": "latex, tex, math, typesetting, documentation, docs",
"forkme": "https://github.com/arnog/mathlive"
},
"opts": {
"outputSourceFiles": true,
"access": "all",
"template": "node_modules/sutro-jsdoc-theme",
"recurse": true,
"destination": "./docs",
"readme": "CONTRIBUTOR_GUIDE.md"
}
}
The keys in the opts section are defined by JSDoc:access
- : only display symbols with the given access property: private, protected, public, undefined or all.recurse
- : when scanning for source files and tutorials, recurse directories.destination
- : path to the output folder for the generated documentationreadme
- : the file to include in the generated documentation as the "home page"outputSourceFiles
- : if true, include prettyfied source files in
The keys in the templates section are specific to Sutro:cleverLinks
- monospaceLinks
- linenums
the documentation
- : if true, include line numbers in prettyfied outputsourceCodeTheme
- : the color scheme used for the prettyfied source code:dark or lightsourceCodeBackground
- : a CSS background shorthand describing the backgroundsourceCodeTheme
used to display source code. Defaults to dark or light color depending on .includeDate
- : if true, include date of documentation creation title
in footer
- : name of the "home" link, at the top left of the pagepageTitle
- : value of the
tag
- description: value of the tag
- keywords: value of the tag
- forkme: if present, display a "Fork Me" banner, with a URL pointing to the
value of this entry
- headerAddendum and bodyAddendum`: if present the content will be inserted Licensed under the Apache2 license.