1.2.0 • Published 4 years ago
deptodoc v1.2.0
Cross platform Command Line Interface utility with Node.js
Document your npm dependencies into your README.md file : dep to doc !
Table of Contents
Installation
We recommend to install dep to doc globally
$ npm install deptodoc --global
Usage
Add the following tag ~~{dependencies}~~
into your README.md
file.
~~{dependencies}~~
Then run the command deptodoc run
, dep to doc cli will replace the tag with your list of installed dependencies from a generated markdown template.
$ deptodoc run
Done !
Notes:
- the generated markdown also provides a usefull minimum table of contents anchor navigation you can use to structure your documentation page
- you will have to remove the generated markdown table of your dependencies and run the cli again in order to include new packages...
Help
$ deptodoc --help
Usage: deptodoc <command> [options]
Commands:
deptodoc run Run deptodoc CLI
deptodoc home Open in browser home page
deptodoc issues Open in browser issues page on GitHub
deptodoc author Open in browser author page on GitHub
Options:
-v, --version Show version number [boolean]
-h, --help Show help [boolean]
List of Packages
Dependencies
Package | Description |
---|---|
cross-env | Run scripts that set and use environment variables across platforms |
inquirer | A collection of common interactive command line user interfaces |
open | Open stuff like URLs, files, executables. Cross-platform |
underscore | JavaScript's functional programming helper library |
yargs | Yargs the modern, pirate-themed, successor to optimist |
devDependencies
Package | Description |
---|---|
better-docs | JSdoc theme |
chai | BDD/TDD assertion library for node.js and the browser. Test framework agnostic |
chai-as-promised | Extends Chai with assertions about promises |
chalk | Terminal string styling done right |
debug | Small debugging utility |
eslint | An AST-based pattern checker for JavaScript |
eslint-config-standard | JavaScript Standard Style - ESLint Shareable Config |
eslint-plugin-import | Import with sanity |
eslint-plugin-node | Additional ESLint's rules for Node.js |
eslint-plugin-promise | Enforce best practices for JavaScript promises |
eslint-plugin-standard | ESlint Plugin for the Standard Linter |
jsdoc | An API documentation generator for JavaScript |
jsdoc-mermaid | A tool to automagically create flowcharts and diagrams in your jsdocs |
mocha | Simple, flexible, fun test framework |
nyc | The Istanbul command line interface |
sinon | JavaScript test spies, stubs and mocks |
Coverage
- Coming soon!
Author
- Thomas G. aka Drozerah - GitHub
License
- MIT © Thomas G. aka Drozerah
1.2.0
4 years ago