jsdoc-simple-theme

Simple theme for gulp-jsdoc3 and jsdoc also.

Less words, better look at these demo screenshots

Installing

1npm install --save jsdoc-simple-theme

2# or using yarn cli
3yarn 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

1{
2	"source": {
3		"includePattern": ".+\\.js(doc|x)?$",
4		"excludePattern": "(^|\\/|\\\\)_"
5	},
6	"tags": {
7		"allowUnknownTags": true,
8		"dictionaries": [
9			"jsdoc",
10			"closure"
11		]
12	},
13	"opts": {
14		"template": "./node_modules/jsdoc-simple-theme/"
15	},
16	"plugins": [
17		"plugins/markdown",
18		"./node_modules/jsdoc-export-default-interop/dist/index",
19		"./node_modules/jsdoc-ignore-code/index",
20		"./node_modules/jsdoc-sourcecode-tag/index"
21	],
22	"markdown": {
23		"parser": "gfm",
24		"hardwrap": true
25	},
26	"templates": {
27		"cleverLinks": false,
28		"monospaceLinks": false,
29		"default": {
30			"outputSourceFiles": true,
31			"layoutFile": "./node_modules/jsdoc-simple-theme/tmpl/layout.tmpl"
32		}
33	}
34}

---

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