Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-22 08:36:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
2f75aa3aed
redoc/cli
History
Roman Hotsiy 2f75aa3aed
chore: remove ci-publish as it was not working
2019-07-29 18:51:54 +03: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 Add missing content type header on compressed responses of / 2019-06-28 10:02:05 -04:00
package.json chore: remove ci-publish as it was not working 2019-07-29 18:51:54 +03:00
README.md chore: move repo to Redocly org 2019-06-04 15:47:22 +03:00
template.hbs feat(cli): add --template option 2018-03-20 11:00:45 +02:00
yarn.lock chore: remove ci-publish as it was not working 2019-07-29 18:51:54 +03: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.