/jsdoc-react

A JSDoc template built with React.

Primary LanguageJavaScriptMIT LicenseMIT

JSDoc React

A JSDoc template with a clean and minimal design.

Built with React, Bootstrap, and WebPack.

Examples

Install

Install the npm package:

> npm install jsdoc-react

Run JSDoc with the template:

> jsdoc -t jsdoc-react ...

Contribute

Build

Build the library:

> make production

Test

Run the tests:

> make test

Release

Ship a new release x.y.z:

> make release version=x.y.z

License

JSDoc React is licensed under the MIT license. See the LICENSE file for more details.