Skip to content

Commit f1dc957

Browse files
committed
Update docs
1 parent 852d813 commit f1dc957

34 files changed

+1708
-208
lines changed

demo-mkdocs/docs/demo/build-in-multiple.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ Add two attribute in swagger-ui tag:
1010
The Swagger UI with multiple OAS takes the first grouped swagger-ui tag position.
1111

1212
```html
13+
## Multiple OAS in single Swagger UI
14+
1315
<swagger-ui grouped name="Pet Store" src="https://petstore.swagger.io/v2/swagger.json"/>
1416
<swagger-ui grouped name="Sample" src="./openapi-spec/sample.yaml"/>
1517
<swagger-ui grouped name="Sample First" src="./openapi-spec/sample-first.yaml"/>
1618
<swagger-ui grouped name="Sample Second" src="./openapi-spec/sample-second.yaml"/>
1719
<swagger-ui grouped name="Sample Third" src="./openapi-spec/sample-third.yaml"/>
20+
21+
## Other independent Swagger UI
22+
23+
<swagger-ui src="./openapi-spec/sample.yaml"/>
1824
```
1925

2026
## Multiple OAS in single Swagger UI

demo-mkdocs/docs/demo/multiple.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ Support render multiple Swagger UI.
44

55
```html
66
<swagger-ui src="./openapi-spec/sample.yaml"/>
7+
<swagger-ui src="./openapi-spec/sample-oauth2.yaml"/>
78
<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
89
```
910

1011
## Swagger UI
1112

1213
<swagger-ui src="./openapi-spec/sample.yaml"/>
14+
<swagger-ui src="./openapi-spec/sample-oauth2.yaml"/>
1315
<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
When using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) you can [hide the sidebar](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#hiding-the-sidebars) to get full width Swagger UI in page.
8+
9+
## Markdown
10+
11+
```html
12+
---
13+
hide:
14+
- navigation
15+
- toc
16+
---
17+
18+
<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
19+
```
20+
21+
## Swagger UI
22+
23+
<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>

demo-mkdocs/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
66

77
1. OpenAPI Specification file from online over URL or static file in docs
88
2. Multiple Swagger UI in same page
9-
3. Synchronized dark mode with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
9+
3. Synchronized dark mode with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
1010
4. Configure [Swagger UI configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) through plugin options and tag attributes
1111
5. Support multiple OAS in single Swagger UI with top bar selector
1212
6. Support Swagger UI [initOAuth](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/) method
@@ -16,7 +16,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
1616
1. Python Package
1717
1. beautifulsoup4>=4.11.1
1818
2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
19-
1. swagger-ui-dist==4.13.2
19+
1. swagger-ui-dist==4.14.0
2020

2121
## Usage
2222

demo-mkdocs/docs/sample.png

3.5 KB
Loading

demo-mkdocs/mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ theme:
1010
name: material
1111
features:
1212
- toc.integrate
13+
- navigation.tabs
1314
palette:
1415
# Palette toggle for automatic mode
1516
- media: "(prefers-color-scheme)"
@@ -53,10 +54,11 @@ plugins:
5354

5455
nav:
5556
- Home: index.md
56-
- Pet Store: pet-store.md
57+
- Pet Store Example: pet-store.md
5758
- Plugin Options: options.md
5859
- Demo:
5960
- Static File: demo/static-file.md
61+
- Full Width Swagger UI: demo/pet-store-full-width.md
6062
- Multiple: demo/multiple.md
6163
- Build-in Multiple: demo/build-in-multiple.md
6264
- OAuth2 Initialization: demo/oauth2.md

docs/404.html

Lines changed: 106 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@
8888

8989

9090

91+
92+
9193
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
9294
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
9395
<label class="md-overlay" for="__drawer"></label>
@@ -187,6 +189,86 @@
187189

188190

189191

192+
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
193+
<div class="md-tabs__inner md-grid">
194+
<ul class="md-tabs__list">
195+
196+
197+
198+
199+
200+
201+
202+
<li class="md-tabs__item">
203+
<a href="/mkdocs-swagger-ui-tag/." class="md-tabs__link">
204+
205+
206+
Home
207+
208+
</a>
209+
</li>
210+
211+
212+
213+
214+
215+
216+
217+
218+
219+
<li class="md-tabs__item">
220+
<a href="/mkdocs-swagger-ui-tag/pet-store/" class="md-tabs__link">
221+
222+
223+
Pet Store Example
224+
225+
</a>
226+
</li>
227+
228+
229+
230+
231+
232+
233+
234+
235+
236+
<li class="md-tabs__item">
237+
<a href="/mkdocs-swagger-ui-tag/options/" class="md-tabs__link">
238+
239+
240+
Plugin Options
241+
242+
</a>
243+
</li>
244+
245+
246+
247+
248+
249+
250+
251+
252+
253+
254+
255+
256+
<li class="md-tabs__item">
257+
<a href="/mkdocs-swagger-ui-tag/demo/static-file/" class="md-tabs__link">
258+
259+
260+
Demo
261+
262+
</a>
263+
</li>
264+
265+
266+
267+
268+
</ul>
269+
</div>
270+
</nav>
271+
190272

191273

192274
<main class="md-main" data-md-component="main">
@@ -199,10 +281,12 @@
199281
<div class="md-sidebar__inner">
200282

201283

284+
285+
202286

203287

204288

205-
<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0">
289+
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
206290
<label class="md-nav__title" for="__drawer">
207291
<a href="/mkdocs-swagger-ui-tag/." title="MkDocs Swagger UI Tag" class="md-nav__button md-logo" aria-label="MkDocs Swagger UI Tag" data-md-component="logo">
208292

@@ -263,7 +347,7 @@
263347

264348

265349
<span class="md-ellipsis">
266-
Pet Store
350+
Pet Store Example
267351
</span>
268352

269353
</a>
@@ -353,6 +437,25 @@
353437

354438

355439

440+
<li class="md-nav__item">
441+
<a href="/mkdocs-swagger-ui-tag/demo/pet-store-full-width/" class="md-nav__link">
442+
443+
444+
<span class="md-ellipsis">
445+
Full Width Swagger UI
446+
</span>
447+
448+
</a>
449+
</li>
450+
451+
452+
453+
454+
455+
456+
457+
458+
356459
<li class="md-nav__item">
357460
<a href="/mkdocs-swagger-ui-tag/demo/multiple/" class="md-nav__link">
358461

@@ -456,7 +559,7 @@ <h1>404 - Not found</h1>
456559
<div class="md-dialog__inner md-typeset"></div>
457560
</div>
458561

459-
<script id="__config" type="application/json">{"base": "/mkdocs-swagger-ui-tag/", "features": ["toc.integrate"], "search": "/mkdocs-swagger-ui-tag/assets/javascripts/workers/search.720157f5.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
562+
<script id="__config" type="application/json">{"base": "/mkdocs-swagger-ui-tag/", "features": ["toc.integrate", "navigation.tabs"], "search": "/mkdocs-swagger-ui-tag/assets/javascripts/workers/search.720157f5.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
460563

461564

462565
<script src="/mkdocs-swagger-ui-tag/assets/javascripts/bundle.15234abc.min.js"></script>

docs/assets/javascripts/swagger-ui-bundle.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/javascripts/swagger-ui-bundle.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/stylesheets/swagger-ui.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)