Adds redirects, link to preview-docs docs, and other review edits

This commit is contained in:
Heather Cloward 2021-09-27 21:56:32 -04:00
parent 762e049511
commit dd2a082b5b
6 changed files with 28 additions and 1 deletions

View File

@ -1,5 +1,7 @@
--- ---
title: Using the Redoc CLI title: Using the Redoc CLI
redirectFrom:
- /docs/quickstart/cli/
--- ---
# Using the Redoc CLI # Using the Redoc CLI

View File

@ -1,5 +1,7 @@
--- ---
title: Using the Redoc Docker image title: Using the Redoc Docker image
redirectFrom:
- /docs/quickstart/docker/
--- ---
# Using the Redoc Docker image # Using the Redoc Docker image

View File

@ -1,5 +1,7 @@
--- ---
title: Using the Redoc HTML element title: Using the Redoc HTML element
redirectFrom:
- /docs/quickstart/html/
--- ---
# Using the Redoc HTML element # Using the Redoc HTML element

View File

@ -1,5 +1,7 @@
--- ---
title: Redoc deployment guide title: Redoc deployment guide
redirectFrom:
- /docs/quickstart/intro/
--- ---
# Redoc deployment guide # Redoc deployment guide
@ -55,9 +57,26 @@ project directory and run the following command:
openapi preview-docs openapi.yaml openapi preview-docs openapi.yaml
``` ```
::: openapi.yaml
Replace `openapi.yaml` in the example command with the file path to your OpenAPI definition.
:::
By default, without providing a port, the preview starts on port 8080, and can be accessed at `http://localhost:8080`. By default, without providing a port, the preview starts on port 8080, and can be accessed at `http://localhost:8080`.
To exit the preview, use `control+C`. To exit the preview, use `control+C`.
You can alter the port if you are using 8080 already, for example:
```bash
openapi preview-docs -p 8888 openapi.yaml
```
::: openapi.yaml
Replace `openapi.yaml` in the example command with the file path to your OpenAPI definition.
:::
For more information about the `preview-docs` command, refer to
[OpenAPI CLI commands](https://redoc.ly/docs/cli/commands/preview-docs/#preview-docs) in the OpenAPI CLI documentation.
#### Using Python #### Using Python
If you have [Python 3](https://www.python.org/downloads/) installed, `cd` into your If you have [Python 3](https://www.python.org/downloads/) installed, `cd` into your

View File

@ -1,5 +1,7 @@
--- ---
title: Using the Redoc React component title: Using the Redoc React component
redirectFrom:
- /docs/quickstart/react/
--- ---
# Using the Redoc React component # Using the Redoc React component

View File

@ -44,7 +44,7 @@ replace the `spec-url` attribute with the URL or local file address to your defi
:::attention Running Redoc locally requires an HTTP server :::attention Running Redoc locally requires an HTTP server
Loading local OpenAPI definitions is impossible without running a web server because of issues with Loading local OpenAPI definitions is impossible without running a web server because of issues with
[same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy) and [same-origin policy](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy) and
other security reasons. Refer to [Running Redoc locally](/deployment/intro/#running_redoc_locally) for other security reasons. Refer to [Running Redoc locally](https://redoc.ly/docs/deployment/intro/#running_redoc_locally) for
more information. more information.
::: :::