redoc-cli
ReDoc's Command Line Interface
Last updated 9 days ago by romanhotsiy .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install redoc-cli 
SYNC missed versions from official npm registry.

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.

Current Tags

  • 0.10.1                                ...           latest (9 days ago)

42 Versions

  • 0.10.1                                ...           9 days ago
  • 0.9.13                                ...           a month ago
  • 0.10.0                                ...           a month ago
  • 0.9.12                                ...           3 months ago
  • 0.9.11                                ...           3 months ago
  • 0.9.10                                ...           4 months ago
  • 0.9.9                                ...           4 months ago
  • 0.9.8                                ...           7 months ago
  • 0.9.7                                ...           8 months ago
  • 0.9.6                                ...           10 months ago
  • 0.9.5                                ...           a year ago
  • 0.9.4                                ...           a year ago
  • 0.9.3 [deprecated]           ...           a year ago
  • 0.9.2                                ...           a year ago
  • 0.9.1                                ...           a year ago
  • 0.8.6                                ...           a year ago
  • 0.8.5                                ...           a year ago
  • 0.8.4                                ...           2 years ago
  • 0.8.3                                ...           2 years ago
  • 0.8.2                                ...           2 years ago
  • 0.8.1                                ...           2 years ago
  • 0.7.0                                ...           2 years ago
  • 0.6.4                                ...           2 years ago
  • 0.6.3                                ...           2 years ago
  • 0.6.2                                ...           2 years ago
  • 0.6.1                                ...           2 years ago
  • 0.5.0                                ...           2 years ago
  • 0.4.0                                ...           2 years ago
  • 0.3.9                                ...           3 years ago
  • 0.3.8                                ...           3 years ago
  • 0.3.7                                ...           3 years ago
  • 0.3.5                                ...           3 years ago
  • 0.3.4                                ...           3 years ago
  • 0.3.3                                ...           3 years ago
  • 0.3.2                                ...           3 years ago
  • 0.3.1                                ...           3 years ago
  • 0.3.0                                ...           3 years ago
  • 0.2.1                                ...           3 years ago
  • 0.2.0                                ...           3 years ago
  • 0.1.1                                ...           3 years ago
  • 0.1.0                                ...           3 years ago
  • 0.0.1                                ...           3 years ago
Maintainers (1)
Downloads
Today 2
This Week 8
This Month 200
Last Day 4
Last Week 101
Last Month 175
Dependencies (12)
Dev Dependencies (3)

Copyright 2014 - 2016 © taobao.org |