jsdoc-simple-theme

!jsdoc3 theme
!license

> Simple theme for gulp-jsdoc3 and jsdoc also.

Less words, better look at these demo screenshots






Installing

``shell
npm install --save jsdoc-simple-theme

or using yarn cli

yarn add jsdoc-simple-theme
`

#### includes

- jsdoc-ignore-code
- jsdoc-sourcecode-tag
- jsdoc-export-default-interop

Code Syntax Highlight

prismjs

- all languages - (http://prismjs.com/index.html#languages-list)
- all plugins (http://prismjs.com/index.html#plugins), except _WebPlatform Docs_ and _Show Invisibles_
- prism-ejs-language - (https://github.com/dutchenkoOleg/prism-ejs-language)

Usage

Add theme and plugins to jsdoc conf.json (http://usejsdoc.org/about-configuring-jsdoc.html)

- opts > template
- templates > default > layoutFile

`json
{
"source": {
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"tags": {
"allowUnknownTags": true,
"dictionaries": [
"jsdoc",
"closure"
]
},
"opts": {
"template": "./node_modules/jsdoc-simple-theme/"
},
"plugins": [
"plugins/markdown",
"./node_modules/jsdoc-export-default-interop/dist/index",
"./node_modules/jsdoc-ignore-code/index",
"./node_modules/jsdoc-sourcecode-tag/index"
],
"markdown": {
"parser": "gfm",
"hardwrap": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"outputSourceFiles": true,
"layoutFile": "./node_modules/jsdoc-simple-theme/tmpl/layout.tmpl"
}
}
}
``

---

Changelog

read CHANGELOG.md

---

Code of Conduct

Please read CODE_OF_CONDUCT.md

---

Contributing

Please read CONTRIBUTING.md

After that - you know what to do -> issues and pulls