Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-25 18:13:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
e675f57e9a
redoc/cli
History
Roman Hotsiy e675f57e9a
chore(cli): update redoc
2020-03-17 14:13:06 +02:00
..
.npmignore chore: fix .npmignore 2018-03-21 18:02:25 +02:00
Dockerfile doc: fix some typos (#1117) 2019-12-10 08:13:37 +02:00
index.ts chore(cli): Lint and prettify cli/index.ts (#1074) 2020-01-10 14:29:09 +02:00
package-lock.json chore(cli): update redoc 2020-03-17 14:13:06 +02:00
package.json chore(cli): update redoc 2020-03-17 14:13:06 +02:00
README.md chore: move repo to Redocly org 2019-06-04 15:47:22 +03:00
template.hbs feat(cli): add disableGoogleFont parameter to cli (#1045) 2019-09-25 18:14:21 +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.