Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-22 16:46:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore: update redoc-cli docs

Browse Source
This commit is contained in:
Roman Hotsiy 2018-03-18 17:55:53 +02:00
parent f993e9b443
commit 03cc781b8d
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
3 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -167,14 +167,14 @@ Here are detailed [options docs](#redoc-options-object).
## ReDoc CLI
You can use redoc cli by installing `redoc` globally or using [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b).
You can use redoc cli by installing `redoc-cli` globally or using [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b).
Twe following commans are available:
- `redoc serve [spec]` - starts the server with `spec` rendered with ReDoc. Supports SSR mode (`--ssr`) and can watch the spec (`--watch`)
- `redoc bundle [spec]` - bundles spec and ReDoc into **zero-dependency** HTML file.
- `redoc-cli serve [spec]` - starts the server with `spec` rendered with ReDoc. Supports SSR mode (`--ssr`) and can watch the spec (`--watch`)
- `redoc-cli bundle [spec]` - bundles spec and ReDoc into **zero-dependency** HTML file.
For more details run `redoc --help`.
For more details run `redoc-cli --help`.
## Configuration

11
cli/README.md
View File

@ -0,0 +1,11 @@
# redoc-cli
**[ReDoc](https://github.com/Rebilly/ReDoc)'s Command Line Interface**
[Documentation](https://github.com/Rebilly/ReDoc/tree/react-rewrite#redoc-cli)
## Installation
TBD
## Usage
TBD

2
cli/package.json
View File

@ -1,6 +1,6 @@
{
"name": "redoc-cli",
"version": "0.2.0",
"version": "0.2.1",
"description": "ReDoc's Command Line Interface",
"main": "index.js",
"bin": {