0.4.2 • Published 6 years ago
shs-docs v0.4.2
shs-docs
A documentation generator package designed for SHSDX OpMod developers.
Getting started
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",
Dependencies
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. |
0.4.2
6 years ago
0.4.1
6 years ago
0.4.0
6 years ago
0.3.3
6 years ago
0.3.2
6 years ago
0.3.1
6 years ago
0.3.0
6 years ago
0.2.9
6 years ago
0.2.8
6 years ago
0.2.7
6 years ago
0.2.6
6 years ago
0.2.5
6 years ago
0.2.4
6 years ago
0.2.3
6 years ago
0.2.0
6 years ago
0.1.9
6 years ago
0.1.8
6 years ago
0.1.7
6 years ago
0.1.6
6 years ago
0.1.5
6 years ago
0.1.4
6 years ago
0.1.3
6 years ago
0.1.2
6 years ago
0.1.1
6 years ago
0.1.0
6 years ago