diff --git a/docs/deployment/cli.md b/docs/deployment/cli.md index b0f2af85..8bfc9e2c 100644 --- a/docs/deployment/cli.md +++ b/docs/deployment/cli.md @@ -1,5 +1,7 @@ --- title: Using the Redoc CLI +redirectFrom: + - /docs/quickstart/cli/ --- # Using the Redoc CLI diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md index 31539fdb..a8c3c9b8 100644 --- a/docs/deployment/docker.md +++ b/docs/deployment/docker.md @@ -1,5 +1,7 @@ --- title: Using the Redoc Docker image +redirectFrom: + - /docs/quickstart/docker/ --- # Using the Redoc Docker image diff --git a/docs/deployment/html.md b/docs/deployment/html.md index 486d4048..872d05ac 100644 --- a/docs/deployment/html.md +++ b/docs/deployment/html.md @@ -1,5 +1,7 @@ --- title: Using the Redoc HTML element +redirectFrom: + - /docs/quickstart/html/ --- # Using the Redoc HTML element diff --git a/docs/deployment/intro.md b/docs/deployment/intro.md index b54120e7..210e1374 100644 --- a/docs/deployment/intro.md +++ b/docs/deployment/intro.md @@ -1,5 +1,7 @@ --- title: Redoc deployment guide +redirectFrom: + - /docs/quickstart/intro/ --- # Redoc deployment guide @@ -55,9 +57,26 @@ project directory and run the following command: 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`. 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 If you have [Python 3](https://www.python.org/downloads/) installed, `cd` into your diff --git a/docs/deployment/react.md b/docs/deployment/react.md index 4b410d21..95378f72 100644 --- a/docs/deployment/react.md +++ b/docs/deployment/react.md @@ -1,5 +1,7 @@ --- title: Using the Redoc React component +redirectFrom: + - /docs/quickstart/react/ --- # Using the Redoc React component diff --git a/docs/quickstart.md b/docs/quickstart.md index 11f71d7e..8548c59b 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -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 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 -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. :::