A documentation generator package designed for SHSDX OpMod developers.
First, install the package.
npm i -D shs-docs
Copy the example/ directory's jsdocs.config.js file to your project root and configure as needed. Then, add the following to your NPM scripts.
"build:docs": "node_modules/shs-docs/src/jsdoc/jsdoc.js -c jsdocs.config.js",SHS-Docs is powered, most importantly, by JSDoc 3, and API documentation generator for JavaScript, & Docdash, a Lodash inspired documentation template theme for JSDoc 3.
| Name | Description |
|---|---|
| docdash | Lodash inspired JSDoc 3 template/theme. |
| jsdoc | An API documentation generator for JavaScript. |
| jsdoc-vue-component | A simple plugin for JSDoc to parse .vue Single-File Components. |
| uikit | A lightweight and modular front-end framework for developing fast and powerful web interfaces. |