From f6c22856a0494eb70f247e50c4a9880caa6f4529 Mon Sep 17 00:00:00 2001 From: louisachu Date: Wed, 7 Feb 2024 14:32:23 -0800 Subject: [PATCH] Update README.md (#1564) update readme --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8e33da0c1..cd0abeb37c 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Using a theme, all of your default configuration lives in an npm package. - [Writing Enhanced Markdown](#writing-enhanced-markdown) - [Metadata with Front matter](#metadata-with-front-matter) - [OpenAPI](#openapi) - - [Redocly API Block](#Redocly API Block) + - [Redocly API Block](#RedoclyAPIBlock) - [JSDoc](#jsdoc) - [MDX](#mdx) - [Modular Content System](#modular-content-system) @@ -1076,8 +1076,11 @@ We use [Redoc](https://github.com/Redocly/redoc) to render OpenAPI specs. Simply -### Redocly API Block +### RedoclyAPIBlock +```js + +``` We can now host your own OpenAPI YAML files and have them rendered by Redocly documents. This approach allows us to avoid using iframes and instead host our own API YAML files directly in Redocly. When implementing this feature, ensure that GATSBY_REDOCLY_KEY: ${{ secrets.REDOCLY_LICENSE_KEY }} is added to the deploy.yml file in the repository. Additionally, for new repositories, remember to include the on-premise license keys through the repository settings.