Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-10 19:06:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

sync: Synced local 'docs/' with remote 'docs/redoc/'

Browse Source
This commit is contained in:
redocly-bot 2021-11-23 17:46:45 +00:00
parent 7e287d984e
commit 82df17d871
2 changed files with 5 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/deployment/intro.md
View File

@ -28,7 +28,7 @@ The following options are supported:
### OpenAPI definition ### OpenAPI definition
You will need an OpenAPI definition. For testing purposes, you can use one of the following sample OpenAPI definitions: You will need an OpenAPI definition. For testing purposes, you can use one of the following sample OpenAPI definitions:
- OpenAPI 3.0 - OpenAPI 3.0
- [Rebilly Users OpenAPI Definition](https://raw.githubusercontent.com/Rebilly/api-definitions/main/openapi/users.yaml) - [Rebilly Users OpenAPI Definition](https://raw.githubusercontent.com/Rebilly/api-definitions/main/openapi/users.yaml)
- [Swagger Petstore Sample OpenAPI Definition](https://petstore3.swagger.io/api/v3/openapi.json) - [Swagger Petstore Sample OpenAPI Definition](https://petstore3.swagger.io/api/v3/openapi.json)
@ -36,7 +36,8 @@ You will need an OpenAPI definition. For testing purposes, you can use one of th
- [Thingful OpenAPI Definition](https://raw.githubusercontent.com/thingful/openapi-spec/master/spec/swagger.yaml) - [Thingful OpenAPI Definition](https://raw.githubusercontent.com/thingful/openapi-spec/master/spec/swagger.yaml)
- [Fitbit Plus OpenAPI Definition](https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml) - [Fitbit Plus OpenAPI Definition](https://raw.githubusercontent.com/TwineHealth/TwineDeveloperDocs/master/spec/swagger.yaml)
::: OpenAPI Specification info
:::info OpenAPI specification
For more information on the OpenAPI specification, refer to the [Learning OpenAPI 3](https://redoc.ly/docs/resources/learning-openapi/) For more information on the OpenAPI specification, refer to the [Learning OpenAPI 3](https://redoc.ly/docs/resources/learning-openapi/)
section in the documentation. section in the documentation.
::: :::
@ -57,9 +58,7 @@ 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.
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`.
@ -70,9 +69,7 @@ You can alter the port if you are using 8080 already, for example:
openapi preview-docs -p 8888 openapi.yaml openapi preview-docs -p 8888 openapi.yaml
``` ```
::: openapi.yaml Replace `openapi.yaml` in the example command with the file path to your OpenAPI definition.
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 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. [OpenAPI CLI commands](https://redoc.ly/docs/cli/commands/preview-docs/#preview-docs) in the OpenAPI CLI documentation.

15
docs/sidebars.yaml
View File

@ -1,15 +0,0 @@
redoc:
- label: Quickstart
- page: redoc/quickstart.md
- group: Deployment
expanded: false
page: redoc/deployment/intro.md
pages:
- label: HTML element
page: redoc/deployment/html.md
- label: React component
page: redoc/deployment/react.md
- label: Docker image
page: redoc/deployment/docker.md
- label: Command-line interface
page: redoc/deployment/cli.md