Skip to content

Commit

Permalink
update readme (#1554)
Browse files Browse the repository at this point in the history
  • Loading branch information
louisachu authored Dec 15, 2023
1 parent d22c738 commit 17cf924
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +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)
- [JSDoc](#jsdoc)
- [MDX](#mdx)
- [Modular Content System](#modular-content-system)
Expand Down Expand Up @@ -1075,6 +1076,12 @@ We use [Redoc](https://github.com/Redocly/redoc) to render OpenAPI specs. Simply
</pre>
### Redocly API Block
We can now host your own open api yaml files and be rendered by Redocly documents. This way can avoid to iframe in and host our own api yaml files in Redocly.
When using this block, GATSBY_REDOCLY_KEY : ${{ secrets.REDOCLY_LICENSE_KEY }} will needs to be added in deploy.yml file in the repo.
### JSDoc
We currently recommend to use the [JSDoc to markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) converter.
Expand Down

0 comments on commit 17cf924

Please sign in to comment.