mirror of
https://github.com/Redocly/redoc.git
synced 2025-08-07 05:40:19 +03:00
Updates from reviews
This commit is contained in:
parent
75bb43401f
commit
04c6f0c710
|
@ -4,9 +4,9 @@ title: Using the Redoc CLI
|
||||||
|
|
||||||
# Using the Redoc CLI
|
# Using the Redoc CLI
|
||||||
|
|
||||||
With Redoc's command-line interface you can locally render your
|
With Redoc's command-line interface you can bundle your OpenAPI definition and API documentation
|
||||||
OpenAPI definition with Redoc and bundle your OpenAPI definition and Redoc into
|
(made with Redoc) into a zero-dependency HTML file and locally render your
|
||||||
a zero-dependency HTML file.
|
OpenAPI definition with Redoc.
|
||||||
|
|
||||||
## Step 1 - Install Redoc CLI
|
## Step 1 - Install Redoc CLI
|
||||||
|
|
||||||
|
@ -21,7 +21,7 @@ Or you can install `redoc-cli` using [npx](https://www.freecodecamp.org/news/npm
|
||||||
|
|
||||||
To install the `redoc-cli` package globally with yarn:
|
To install the `redoc-cli` package globally with yarn:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
yarn global add redoc-cli
|
yarn global add redoc-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ yarn global add redoc-cli
|
||||||
|
|
||||||
To install the `redoc-cli` package globally with npm:
|
To install the `redoc-cli` package globally with npm:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
npm i -g redoc-cli
|
npm i -g redoc-cli
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -61,13 +61,13 @@ The CLI includes the following commands:
|
||||||
- **`--help`:** Prints help text for the Redoc CLI commands and options.
|
- **`--help`:** Prints help text for the Redoc CLI commands and options.
|
||||||
- **`--version`:** Prints the version of the `redoc-cli` package you have installed.
|
- **`--version`:** Prints the version of the `redoc-cli` package you have installed.
|
||||||
|
|
||||||
### Redoc CLI Examples
|
### Redoc CLI examples
|
||||||
|
|
||||||
#### Bundle
|
#### Bundle
|
||||||
|
|
||||||
Bundle with the main color changed to `orange`:
|
Bundle with the main color changed to `orange`:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
redoc-cli bundle openapi.yaml --options.theme.colors.primary.main=orange
|
redoc-cli bundle openapi.yaml --options.theme.colors.primary.main=orange
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -120,7 +120,7 @@ in the yarn documentation.
|
||||||
|
|
||||||
After navigating to your project directory in your terminal, use the following command:
|
After navigating to your project directory in your terminal, use the following command:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
yarn add redoc
|
yarn add redoc
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -128,7 +128,7 @@ yarn add redoc
|
||||||
|
|
||||||
After navigating to your project directory in your terminal, use the following command:
|
After navigating to your project directory in your terminal, use the following command:
|
||||||
|
|
||||||
```sh
|
```bash
|
||||||
npm i redoc
|
npm i redoc
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user