nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 02:33:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

swagger: clarify print #333

Browse source
This commit is contained in:
Sören Weber 2022-10-06 22:47:24 +02:00
parent f2338e63f1
commit 0a5e725b9a
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
exampleSite/content/shortcodes/swagger/_index.en.md
View file

@ -39,6 +39,12 @@ While the examples are using shortcodes with named parameter you are free to als
|:---------------------|:-----------------|:------------|
| **src** | _<empty>_ | The URL to the OpenAPI Specification file. This can be relative to the URL of your page if it is a leaf or branch bundle. |
{{% notice note %}}
If you want to print out (or generate a PDF) from your Swagger documentation, don't initiate printing directly from the page because the elements are optimized for interactive usage in a browser.
Instead, open the [print preview]({{% relref "basics/configuration/#activate-print-support" %}}) in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.
{{% /notice %}}
## Configuration
Swagger is configured with default settings. You can customize Swagger's default settings for all of your files thru a JSON object in your `config.toml` or override these settings per page thru your pages frontmatter.