shs-docs
A documentation generator package designed for SHSDX OpMod developers.
Last updated 2 years ago by williampansky .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install shs-docs 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 0.4.2                                ...           latest (2 years ago)

25 Versions

  • 0.4.2                                ...           2 years ago
  • 0.4.1                                ...           2 years ago
  • 0.4.0                                ...           2 years ago
  • 0.3.3                                ...           2 years ago
  • 0.3.2                                ...           2 years ago
  • 0.3.1                                ...           2 years ago
  • 0.3.0                                ...           2 years ago
  • 0.2.9                                ...           2 years ago
  • 0.2.8                                ...           2 years ago
  • 0.2.7                                ...           2 years ago
  • 0.2.6                                ...           2 years ago
  • 0.2.5                                ...           2 years ago
  • 0.2.4                                ...           2 years ago
  • 0.2.3                                ...           2 years ago
  • 0.2.0                                ...           2 years ago
  • 0.1.9                                ...           2 years ago
  • 0.1.8                                ...           2 years ago
  • 0.1.7                                ...           2 years ago
  • 0.1.6                                ...           2 years ago
  • 0.1.5                                ...           2 years ago
  • 0.1.4                                ...           2 years ago
  • 0.1.3                                ...           2 years ago
  • 0.1.2                                ...           2 years ago
  • 0.1.1                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (2)
Dev Dependencies (30)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |