Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-10 19:06:34 +03:00
Code Issues Packages Projects Releases Wiki Activity
ebe8d3f68c
redoc/cli
History
Roman Hotsiy bba40cd34a
Merge 'mes3fork/watch-backend'
2018-11-06 11:00:12 +02:00
..
.npmignore chore: fix .npmignore 2018-03-21 18:02:25 +02:00
index.ts refactor(cli): Use chokidar for watching 2018-11-03 17:03:59 +01:00
package.json Merge 'mes3fork/watch-backend' 2018-11-06 11:00:12 +02:00
README.md chore: Update readme color customization example (#619) 2018-08-23 18:58:13 +03:00
template.hbs feat(cli): add --template option 2018-03-20 11:00:45 +02:00
yarn.lock Merge 'mes3fork/watch-backend' 2018-11-06 11:00:12 +02:00

README.md

redoc-cli

ReDoc's Command Line Interface

Installation

You can use redoc cli by installing redoc-cli globally or using npx.

Usage

Two following commands are available:

  • 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.

Some examples:

  • Bundle with main color changed to orange:
    $ redoc-cli bundle [spec] --options.theme.colors.primary.main=orange
  • Serve with nativeScrollbars option set to true:
    $ redoc-cli serve [spec] --options.nativeScrollbars
  • Bundle using custom template (check default template for reference):
    $ redoc-cli bundle [spec] -t custom.hbs

For more details run redoc-cli --help.