Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-09-21 03:08:48 +03:00
Code Issues Packages Projects Releases Wiki Activity
ab3e8a8f80
redoc/cli/README.md
Waldir Pimenta eba55124c9
docs: improve the redoc cli README (#1679) 
- Break some long lines
- Add some articles (the, a)
- Add a couple links for additional context
- Expand the SSR acronym
- Describe what --watch does
2021-07-09 10:25:52 +03:00

1.4 KiB
Raw Blame History

redoc-cli

ReDoc's Command Line Interface

Installation

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

Usage

The two following commands are available:

  • redoc-cli serve [spec] - starts the server with spec rendered with ReDoc. Supports a server-side rendering mode (--ssr), and can watch the spec (--watch) to automatically reload the page whenever it changes.
  • redoc-cli bundle [spec] - bundles spec and ReDoc into a zero-dependency HTML file.

Some examples:

  • Bundle with the main color changed to orange:
    $ redoc-cli bundle [spec] --options.theme.colors.primary.main=orange
  • Serve with the nativeScrollbars option set to true:
    $ redoc-cli serve [spec] --options.nativeScrollbars
  • Bundle using a custom Handlebars template (check the default template for an example):
    $ redoc-cli bundle [spec] -t custom.hbs
  • Bundle using a 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.