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
6b152c67ef
redoc/cli
History
Roman Hotsiy 6b152c67ef
chore: update peerDeps before release
2019-03-15 11:37:54 +02:00
..
.npmignore chore: fix .npmignore 2018-03-21 18:02:25 +02:00
Dockerfile Feature/dockerize redoc cli (#614) 2018-11-27 09:36:06 +02:00
index.ts chore: fix cli declarations 2019-03-11 17:58:23 +02:00
package.json chore: update peerDeps before release 2019-03-15 11:37:54 +02:00
README.md feat(cli): Add templateOptions param to pass additional data to custom template (#792) 2019-01-31 09:51:44 +08:00
template.hbs feat(cli): add --template option 2018-03-20 11:00:45 +02:00
yarn.lock chore: update cli deps 2018-11-27 13:31:52 +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
  • Bundle using custom template and add custom templateOptions:
    $ redoc-cli bundle [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"

For more details run redoc-cli --help.