@abios/abios-redoc-cli 中文文档教程

发布于 3年前 浏览 18 项目主页 更新于 3年前

abios-redoc-cli

Abios ReDoc 的命令行界面

Installation

你可以使用 abios 的 redoc 分支cli 通过全局安装 @abios/abios-redoc-cli。\ 运行:yarn global add @abios/abios-redoc-cli

Usage

以下两个命令可用:

  • abios-redoc-cli serve [spec] - starts the server with spec rendered with Abios ReDoc. Supports SSR mode (--ssr) and can watch the spec (--watch)
  • abios-redoc-cli bundle [spec] - bundles spec and ReDoc into zero-dependency HTML file.

一些示例:

  • Bundle with main color changed to orange:
    $ abios-redoc-cli bundle [spec] --options.theme.colors.primary.main=orange
  • Serve with nativeScrollbars option set to true:
    $ abios-redoc-cli serve [spec] --options.nativeScrollbars
  • Bundle using custom template (check default template for reference):
    $ abios-redoc-cli bundle [spec] -t custom.hbs
  • Bundle using custom template and add custom templateOptions:
    $ abios-redoc-cli bundle [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"

有关更多详细信息,请运行 abios-redoc-cli --help

请在此处查看原始的Redoc-CLI 存储库

abios-redoc-cli

Abios ReDoc's Command Line Interface

Installation

You can use abios' fork of redoc cli by installing @abios/abios-redoc-cli globally.\ Run: yarn global add @abios/abios-redoc-cli.

Usage

Two following commands are available:

  • abios-redoc-cli serve [spec] - starts the server with spec rendered with Abios ReDoc. Supports SSR mode (--ssr) and can watch the spec (--watch)
  • abios-redoc-cli bundle [spec] - bundles spec and ReDoc into zero-dependency HTML file.

Some examples:

  • Bundle with main color changed to orange:
    $ abios-redoc-cli bundle [spec] --options.theme.colors.primary.main=orange
  • Serve with nativeScrollbars option set to true:
    $ abios-redoc-cli serve [spec] --options.nativeScrollbars
  • Bundle using custom template (check default template for reference):
    $ abios-redoc-cli bundle [spec] -t custom.hbs
  • Bundle using custom template and add custom templateOptions:
    $ abios-redoc-cli bundle [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"

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

See the original Redoc-CLI repo here.

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文