Documentation
December 6, 2019 ยท View on GitHub
SlimIO Documentation Generator (CLI)
Requirements
- Node.js v12 or higher
Getting Started
This package is available in the Node Package Repository and can be easily installed with npm or yarn.
$ npm i @slimio/documentation
# or
$ yarn add @slimio/documentation
Usage example
TBC
API
TBC
Dependencies
| Name | Refactoring | Security Risk | Usage |
|---|---|---|---|
| @polka/send-type | Minor | Low | HTTP response helper |
| @slimio/arg-parser | Minor | Low | Script argument parser |
| @slimio/is | Minor | Low | Type checker |
| @slimio/jsdoc | Minor | High | JSDoc Generator/Parser |
| @slimio/manifest | Minor | High | Manifest |
| dotenv | Minor | Low | Env file |
| kleur | Minor | Low | TTY color |
| polka | ??Major | Low | Native HTTP server |
| semver | ??Major | Low | SemVer validation |
| serve-static | ??Major | High | Create and parse HTTP Content-Disposition header |
| zup | ??Major | Low | template engine for node |
License
MIT