jsdoc-wmf-theme
A theme for JSDoc 3 conforming to the Wikimedia style guide. Forked from the default template for JSDoc 3, which uses the Taffy Database library and the Underscore Template library.
Example
See https://doc.wikimedia.org/Parsoid/master/ for a sample demo.
Install
$ npm install --save https://github.com/cscott/jsdoc-wmf-themeUsage
In your jsdoc.json file, add a template option.
"opts": {
"template": "node_modules/jsdoc-wmf-theme"
}Options
This theme supports the following options:
"templates": {
"wmf": {
"maintitle": [string, overrides name from package.json],
"repository": [string, overrides repo from package.json],
"hideSections": ["Events"…]
// This could include Modules, Externals, Namespaces, Classes,
// Interfaces, Events, Mixins, and Tutorials. The sections added
// here will not be shown in the sidebar.
}
}
Place them anywhere inside your jsdoc.json file.
Thanks
Thanks to the default JSDoc theme and to the Wikimedia User Interface Style Guide.
License
Licensed under the Apache License, version 2.0.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent