Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-27 02:53:43 +03:00
Code Issues Packages Projects Releases Wiki Activity
feat/sideNavStyle-idonly
redoc/cli
History
AlexVarchuk eb096b69be
fix: rename bandle command and add deprecate notice (#1935) 
Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
2022-03-21 17:21:02 +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 fix: rename bandle command and add deprecate notice (#1935) 2022-03-21 17:21:02 +02:00
npm-shrinkwrap.json chore: update openapi-core and yargs libs (#1934) 2022-03-18 17:30:23 +02:00
package.json chore: update openapi-core and yargs libs (#1934) 2022-03-18 17:30:23 +02:00
README.md docs: improve the redoc cli README (#1679) 2021-07-09 10:25:52 +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 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.