Skip to content

Commit

Permalink
Add note on SwaggerUI and networking (#2030)
Browse files Browse the repository at this point in the history
  • Loading branch information
theletterf authored Jun 4, 2024
1 parent 192113c commit 30249c7
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions userguide/content/en/docs/adding-content/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,10 @@ description: Reference for the Pet Store API

You can customize Swagger UI's look and feel by overriding Swagger's CSS in `themes/docsy/assets/scss/_swagger.scss`.

{{% alert title="Warning" color="warning" %}}
This shortcode relies on JavaScript libraries hosted on unpkg. Make sure that you can access unpkg from your network when building or loading your site.
{{% /alert %}}

### redoc

The `redoc` shortcode uses the open-source [Redoc](https://github.com/Redocly/redoc) tool to render reference API documentation from an OpenAPI YAML or JSON file. This can be hosted anywhere you like, for example in your site's root [`/static` folder](/docs/adding-content/content/#adding-static-content), but you can use a URL as well, for example:
Expand Down

0 comments on commit 30249c7

Please sign in to comment.