Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-22 00:26:34 +03:00
Code Issues Packages Projects Releases Wiki Activity
8376068bfa
redoc/cli
History
pengfluf f3de47738b docs: cli -> README.md typos fixed (#476)
2018-04-26 17:10:37 +03:00
..
.npmignore chore: fix .npmignore 2018-03-21 18:02:25 +02:00
index.ts fix(cli): don't wait for content loaded in bundled HTML 2018-03-22 17:49:15 +02:00
package.json chore: Release 2.0.0-alpha.18 🔖 2018-03-23 08:26:53 +02:00
README.md docs: cli -> README.md typos fixed (#476) 2018-04-26 17:10:37 +03:00
template.hbs feat(cli): add --template option 2018-03-20 11:00:45 +02:00
yarn.lock chore: add handlebars typings 2018-03-20 11:29:38 +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.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.