Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including shs-docs with all npm packages installed. Try it out:

var shsDocs = require("shs-docs")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

shs-docs v0.4.2

A documentation generator package designed for SHSDX OpMod developers.

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][jsdoc], and API documentation generator for JavaScript, & [Docdash][docdash], a Lodash inspired documentation template theme for JSDoc 3.

NameDescription
[docdash][docdash]Lodash inspired JSDoc 3 template/theme.
[jsdoc][jsdoc]An API documentation generator for JavaScript.
[jsdoc-vue-component][jsdoc-vue]A simple plugin for JSDoc to parse .vue Single-File Components.
[uikit][uikit]A lightweight and modular front-end framework for developing fast and powerful web interfaces.
[docdash]: https://github.com/clenemt/docdash [jsdoc]: https://github.com/jsdoc3/jsdoc [jsdoc-vue]: https://github.com/ccqgithub/jsdoc-vue-component [prism-treeview]: https://github.com/Golmote/prism-treeview [uikit]: https://getuikit.com/docs/introduction

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free