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

docs: CLI basic docs

Browse Source
This commit is contained in:
Roman Hotsiy 2018-03-15 20:56:11 +02:00
parent fe3245a7a6
commit 3bbd358b24
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -163,6 +163,17 @@ Also you can pass options:
Here are detailed [options docs](#redoc-options-object). 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).
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.
For more details run `redoc --help`.
## Configuration ## Configuration
### Security Definition location ### Security Definition location