Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-10-29 06:47:26 +03:00
Code Issues Packages Projects Releases Wiki Activity
d2cdaa1221
redoc/cli
History
Andrew Tatomyr d2cdaa1221
fix: wrong base url format causing error when constructing new URL (#1996) 
Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com>
Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com>
Co-authored-by: Anastasiia Derymarko <anastasiia@redocly.com>
2022-05-12 12:05:22 +03:00
..
__test__/build/configRedoc fix: wrong base url format causing error when constructing new URL (#1996) 2022-05-12 12:05:22 +03: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 feat: support .redocly.yaml for options for redoc-cli (#1981) 2022-05-11 08:58:24 +03:00
npm-shrinkwrap.json chore:cli-v0.13.12 (#1993) 2022-05-10 18:48:29 +03:00
package.json chore:cli-v0.13.12 (#1993) 2022-05-10 18:48:29 +03:00
README.md feat: support .redocly.yaml for options for redoc-cli (#1981) 2022-05-11 08:58:24 +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.
    Deprecated. Use npx @redocly/openapi-cli preview-docs [spec]
  • redoc-cli bundle [spec] - bundles spec and Redoc into a zero-dependency HTML file.
    Deprecated. Use Use "build" command instead.
  • redoc-cli build [spec] - build spec and Redoc into a zero-dependency HTML file.

Some examples:

  • Bundle with the main color changed to orange:
    $ redoc-cli build [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 build [spec] -t custom.hbs
  • Bundle using a custom template and add custom templateOptions:
    $ redoc-cli build [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"

With a Redocly configuration file (more info):

  1. Go to folder with your Redocly configuration file (.redocly.yaml or redocly.yaml) and your OpenAPI definition file.
  2. Build the site using the build command (options from the Redocly configuration file will be automatically fetched):
    redoc build openapi.yaml

For more details, run redoc-cli --help.