From aadc32c1ebd6eb93d4e222dea3b2b0213c38af2e Mon Sep 17 00:00:00 2001 From: redocly-bot Date: Thu, 21 Sep 2023 14:20:06 +0000 Subject: [PATCH] sync: Synced local 'docs/' with remote 'docs/redoc/' --- docs/quickstart.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 docs/quickstart.md diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 00000000..1b01e0f1 --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,54 @@ +--- +title: Redoc quickstart guide +--- + +# Redoc quickstart guide + +To render your OpenAPI definition using Redoc, use the following HTML code sample and +replace the `spec-url` attribute with the URL or local file address to your definition. + +```html + + + + Redoc + + + + + + + + + + + + + + + +``` + +:::attention Redoc requires an HTTP server to run locally + +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.md#how-to-run-redoc-locally) for more information. + +::: + +For a more detailed explanation with step-by-step instructions and additional options for using Redoc, refer to the [Redoc deployment guide](./deployment/intro.md).