Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-06-05 13:33:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: use relative links to the Redocly CLI docs as they now are versioned

Browse Source
This commit is contained in:
Andrew Tatomyr 2025-05-20 18:51:25 +03:00
parent 9a2a0082bb
commit 3e11ded397
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/deployment/cli.md
View File

@ -12,9 +12,9 @@ With Redocly CLI, you can bundle your OpenAPI definition and API documentation
First, you need to install the `@redocly/cli` package. First, you need to install the `@redocly/cli` package.
You can install it [globally](../../cli/installation.md#install-globally) using npm or Yarn. You can install it [globally](../../cli/installation#install-globally) using npm or Yarn.
Or you can install it during [runtime](../../cli/installation.md#use-npx-at-runtime) using npx or Docker. Or you can install it during [runtime](../../cli/installation#use-npx-at-runtime) using npx or Docker.
## Step 2 - Build the HTML file ## Step 2 - Build the HTML file
@ -27,9 +27,9 @@ replacing `apis/openapi.yaml` with your API definition file's name and path:
redocly build-docs apis/openapi.yaml redocly build-docs apis/openapi.yaml
``` ```
See the [build-docs](../../cli/commands/build-docs.md) documentation for more information See the [build-docs](../../cli/commands/build-docs) documentation for more information
on the different options and ways you can use the command. on the different options and ways you can use the command.
Also, check out [Redocly CLI commands](../../cli/commands/index.md), for more Also, check out [Redocly CLI commands](../../cli/commands), for more
information on the different things you can do with Redocly CLI including information on the different things you can do with Redocly CLI including
linting, splitting, and bundling your API definition file. linting, splitting, and bundling your API definition file.

4
docs/index.md
View File

@ -57,7 +57,7 @@ Check out the [deployment documentation](./deployment/intro.md) for more options
Redoc is highly configurable. Each deployment option accepts configuration in a way that's appropriate to that platform, but the options are the same for each. For example: Redoc is highly configurable. Each deployment option accepts configuration in a way that's appropriate to that platform, but the options are the same for each. For example:
* Using [Redocly CLI](../cli/index.md), configuration goes in the `redocly.yaml` file, or can be supplied as command line parameters, such as `--theme.openapi.disableSearch`. * Using [Redocly CLI](../cli), configuration goes in the `redocly.yaml` file, or can be supplied as command line parameters, such as `--theme.openapi.disableSearch`.
* Using HTML or React, configure by setting `option` in the tag. * Using HTML or React, configure by setting `option` in the tag.
Here's a sample `redocly.yaml` configuration file, showing a few common settings and tweaking some of the visual theme settings: Here's a sample `redocly.yaml` configuration file, showing a few common settings and tweaking some of the visual theme settings:
@ -92,6 +92,6 @@ There are many, many more options available. Visit the [configuration reference]
## Next steps ## Next steps
* If you are new to OpenAPI, try the [OpenAPI starter project](../cli/openapi-starter.md) for a great introduction. * If you are new to OpenAPI, try the [OpenAPI starter project](../cli/openapi-starter) for a great introduction.
* Ready to build documentation from an existing OpenAPI file? Go to the [Redoc quickstart](./quickstart.md) and get started. * Ready to build documentation from an existing OpenAPI file? Go to the [Redoc quickstart](./quickstart.md) and get started.
* Learn more about the project by visiting [Redoc on GitHub](https://github.com/Redocly/redoc). * Learn more about the project by visiting [Redoc on GitHub](https://github.com/Redocly/redoc).