https://github.com/yehiyam/cli-docs
Command Line for generating Readme.md documentation from yargs based cli tools
https://github.com/yehiyam/cli-docs
cli documentation readme readme-md yargs
Last synced: 5 months ago
JSON representation
Command Line for generating Readme.md documentation from yargs based cli tools
- Host: GitHub
- URL: https://github.com/yehiyam/cli-docs
- Owner: yehiyam
- License: mit
- Created: 2020-08-13T15:54:35.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-26T07:39:56.000Z (almost 6 years ago)
- Last Synced: 2024-12-30T05:49:25.157Z (over 1 year ago)
- Topics: cli, documentation, readme, readme-md, yargs
- Language: JavaScript
- Homepage:
- Size: 28.3 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# cli-md-docs
Tool for creating markdown Readme documentation for cli tools created with
[yargs](https://github.com/yargs/yargs)
## Install
```shell
npm i -g cli-md-docs
```
## Usage
## cli-md-docs
---
```shell
$ cli-md-docs
```
Tool for creating markdown Readme documentation for cli tools created with
[yargs](https://github.com/yargs/yargs)
Options:
|option|description|type|required|default|
|---|---|---|---|---|
|--help|Show help|boolean|||
|--version|Show version number|boolean|||
|--path|path to the cli executable|string|true||
|--name|real name of the cli. If omitted, the name of the executable is used|string|||
|--output, -o|the output file.|string||./Readme.md|
|--installTemplate|replaces the default how to install.|string|||