Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-06-30 01:03:03 +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 2022-03-14 10:21:58 +00:00
parent 0f4ae0196d
commit cb3d0a018e
8 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/deployment/cli.md
View File

@ -54,7 +54,7 @@ The CLI includes the following commands:
a reference to an OpenAPI definition. Options include: a reference to an OpenAPI definition. Options include:
- `--ssr`: Implements a server-side rendering model. - `--ssr`: Implements a server-side rendering model.
- `--watch`: Automatically reloads the server while you edit your OpenAPI definition. - `--watch`: Automatically reloads the server while you edit your OpenAPI definition.
- `--options`: Customizes your output using [Redoc options](https://redoc.ly/docs/api-reference-docs/configuration/). - `--options`: Customizes your output using [Redoc options](https://redocly.com/docs/api-reference-docs/configuration/).
To add nested options, use dot notation. To add nested options, use dot notation.
- **`redoc-cli bundle [spec]`:** Bundles `spec` and Redoc into a zero-dependency HTML file. Options include: - **`redoc-cli bundle [spec]`:** Bundles `spec` and Redoc into a zero-dependency HTML file. Options include:
- `-t` or `--template`: Uses custom [Handlebars](https://handlebarsjs.com/) templates to render your OpenAPI definition. - `-t` or `--template`: Uses custom [Handlebars](https://handlebarsjs.com/) templates to render your OpenAPI definition.

2
docs/deployment/html.md
View File

@ -97,7 +97,7 @@ Redoc.init(specOrSpecUrl, options, element, callback)
``` ```
- `specOrSpecUrl`: Either a JSON object with the OpenAPI definition or a URL to the - `specOrSpecUrl`: Either a JSON object with the OpenAPI definition or a URL to the
definition in JSON or YAML format. definition in JSON or YAML format.
- `options`: See [options object](https://redoc.ly/docs/api-reference-docs/configuration/) reference. - `options`: See [options object](https://redocly.com/docs/api-reference-docs/configuration/) reference.
- `element`: DOM element Redoc will be inserted into. - `element`: DOM element Redoc will be inserted into.
- `callback`(optional): Callback to be called after Redoc has been fully rendered. - `callback`(optional): Callback to be called after Redoc has been fully rendered.
It is also called on errors with `error` as the first argument. It is also called on errors with `error` as the first argument.

6
docs/deployment/intro.md
View File

@ -38,7 +38,7 @@ You will need an OpenAPI definition. For testing purposes, you can use one of th
- [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)
:::info OpenAPI specification :::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://redocly.com/docs/resources/learning-openapi/)
section in the documentation. section in the documentation.
::: :::
@ -51,7 +51,7 @@ If you want to view your Redoc output locally, you can simulate an HTTP server.
Redocly OpenAPI CLI is an open source command-line tool that includes a command Redocly OpenAPI CLI is an open source command-line tool that includes a command
for simulating an HTTP server to provide a preview of your OpenAPI definition locally. for simulating an HTTP server to provide a preview of your OpenAPI definition locally.
If you have [OpenAPI CLI](https://redoc.ly/docs/cli/#installation-and-usage) installed, `cd` into your If you have [OpenAPI CLI](https://redocly.com/docs/cli/#installation-and-usage) installed, `cd` into your
project directory and run the following command: project directory and run the following command:
```bash ```bash
@ -72,7 +72,7 @@ openapi preview-docs -p 8888 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://redocly.com/docs/cli/commands/preview-docs/#preview-docs) in the OpenAPI CLI documentation.
#### Python #### Python

2
docs/deployment/react.md
View File

@ -59,7 +59,7 @@ For example:
``` ```
For more information on configuration options, refer to the For more information on configuration options, refer to the
[Configuration options for Reference docs](https://redoc.ly/docs/api-reference-docs/configuration/) [Configuration options for Reference docs](https://redocly.com/docs/api-reference-docs/configuration/)
section of the documentation. Options available for Redoc are noted, section of the documentation. Options available for Redoc are noted,
"Supported in Redoc CE". "Supported in Redoc CE".

8
docs/quickstart/cli.md
View File

@ -19,7 +19,7 @@ Or you can install `redoc-cli` using [npx](https://www.freecodecamp.org/news/npm
### Install Redoc CLI with yarn ### Install Redoc CLI with yarn
To install the `redoc-cli` package globally with yarn: To install the `redoc-cli` package globally with yarn:
```bash ```bash
yarn global add redoc-cli yarn global add redoc-cli
@ -27,7 +27,7 @@ yarn global add redoc-cli
### Install Redoc with npm ### Install Redoc with npm
To install the `redoc-cli` package globally with npm: To install the `redoc-cli` package globally with npm:
```bash ```bash
npm i -g redoc-cli npm i -g redoc-cli
@ -50,9 +50,9 @@ The CLI includes the following commands:
- **`redoc-cli serve [spec]`:** Starts a local server with Redoc. You must include the required parameter, spec, which is - **`redoc-cli serve [spec]`:** Starts a local server with Redoc. You must include the required parameter, spec, which is
a reference to an OpenAPI definition. Options include: a reference to an OpenAPI definition. Options include:
- `--ssr`: Implements a server-side rendering model. - `--ssr`: Implements a server-side rendering model.
- `--watch`: Automatically reloads the server while you edit your OpenAPI definition. - `--watch`: Automatically reloads the server while you edit your OpenAPI definition.
- `--options`: Customizes your output using [Redoc options](https://redoc.ly/docs/api-reference-docs/configuration/). - `--options`: Customizes your output using [Redoc options](https://redocly.com/docs/api-reference-docs/configuration/).
To add nested options, use dot notation. To add nested options, use dot notation.
- **`redoc-cli bundle [spec]`:** Bundles `spec` and Redoc into a zero-dependency HTML file. Options include: - **`redoc-cli bundle [spec]`:** Bundles `spec` and Redoc into a zero-dependency HTML file. Options include:
- `-t` or `--template`: Uses custom [Handlebars](https://handlebarsjs.com/) templates to render your OpenAPI definition. - `-t` or `--template`: Uses custom [Handlebars](https://handlebarsjs.com/) templates to render your OpenAPI definition.

16
docs/quickstart/html.md
View File

@ -37,7 +37,7 @@ title: Using the Redoc HTML element
:::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. other security reasons.
::: :::
### Running Redoc locally ### Running Redoc locally
@ -49,7 +49,7 @@ If you want to view your Redoc output locally, you can simulate an HTTP server.
Redocly OpenAPI CLI is an open source command-line tool that includes a command Redocly OpenAPI CLI is an open source command-line tool that includes a command
for simulating an HTTP server to provide a preview of your OpenAPI definition locally. for simulating an HTTP server to provide a preview of your OpenAPI definition locally.
If you have [OpenAPI CLI](https://redoc.ly/docs/cli/#installation-and-usage) installed, `cd` into your If you have [OpenAPI CLI](https://redocly.com/docs/cli/#installation-and-usage) installed, `cd` into your
project directory and run the following command: project directory and run the following command:
```bash ```bash
@ -107,9 +107,9 @@ You can install Redoc using one of the following package managers:
If you do not have a `package.json` file in your project directory, If you do not have a `package.json` file in your project directory,
you need to add one by initializing npm or yarn in your project. Use the command `npm init` for npm, you need to add one by initializing npm or yarn in your project. Use the command `npm init` for npm,
or `yarn init` for yarn. These initialization commands will lead you through the process or `yarn init` for yarn. These initialization commands will lead you through the process
of creating a `package.json` file in your project. of creating a `package.json` file in your project.
For more information, see For more information, see
[Creating a package.json file](https://docs.npmjs.com/creating-a-package-json-file) [Creating a package.json file](https://docs.npmjs.com/creating-a-package-json-file)
in the npm documentation or [Yarn init](https://classic.yarnpkg.com/en/docs/cli/init/) in the npm documentation or [Yarn init](https://classic.yarnpkg.com/en/docs/cli/init/)
in the yarn documentation. in the yarn documentation.
@ -118,7 +118,7 @@ in the yarn documentation.
### Install Redoc with yarn ### Install Redoc with yarn
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:
```bash ```bash
yarn add redoc yarn add redoc
@ -126,7 +126,7 @@ yarn add redoc
### Install Redoc with npm ### Install Redoc with npm
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:
```bash ```bash
npm i redoc npm i redoc
@ -188,7 +188,7 @@ Redoc.init(specOrSpecUrl, options, element, callback)
``` ```
- `specOrSpecUrl`: Either a JSON object with the OpenAPI definition or a URL to the - `specOrSpecUrl`: Either a JSON object with the OpenAPI definition or a URL to the
definition in JSON or YAML format. definition in JSON or YAML format.
- `options`: See [options object](https://redoc.ly/docs/api-reference-docs/configuration/) reference. - `options`: See [options object](https://redocly.com/docs/api-reference-docs/configuration/) reference.
- `element`: DOM element Redoc will be inserted into. - `element`: DOM element Redoc will be inserted into.
- `callback`(optional): Callback to be called after Redoc has been fully rendered. - `callback`(optional): Callback to be called after Redoc has been fully rendered.
It is also called on errors with `error` as the first argument. It is also called on errors with `error` as the first argument.
@ -211,4 +211,4 @@ Redoc.init('dist.yaml', {
scrollYOffset: 50 scrollYOffset: 50
}, document.getElementById('redoc-container')) }, document.getElementById('redoc-container'))
</script> </script>
``` ```

4
docs/quickstart/intro.md
View File

@ -25,7 +25,7 @@ The following options are supported:
## Before you start ## Before you start
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)
@ -33,7 +33,7 @@ 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)
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://redocly.com/docs/resources/learning-openapi/)
section in the documentation. section in the documentation.
## Live demo online ## Live demo online

6
docs/quickstart/react.md
View File

@ -42,7 +42,7 @@ Or you can pass your OpenAPI definition as an object, using the following format
## Optional - Pass options ## Optional - Pass options
Options can be passed into the RedocStandalone component to alter how it renders. Options can be passed into the RedocStandalone component to alter how it renders.
For example: For example:
@ -56,8 +56,8 @@ For example:
/> />
``` ```
For more information on configuration options, refer to the For more information on configuration options, refer to the
[Configuration options for Reference docs](https://redoc.ly/docs/api-reference-docs/configuration/) [Configuration options for Reference docs](https://redocly.com/docs/api-reference-docs/configuration/)
section of the documentation. Options available for Redoc are noted, section of the documentation. Options available for Redoc are noted,
"Supported in Redoc CE". "Supported in Redoc CE".