Skip to content

Commit 550765e

Browse files
blueswenblueswen
committed
update docs
1 parent f790651 commit 550765e

25 files changed

+1320
-246
lines changed

‎demo-mkdocs/docs/index.md‎

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

55
## Features
66

7-
1. Multiple OpenAPI Specification file source: url, static file in docs
7+
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/)
910

1011
## Dependency
1112

@@ -39,7 +40,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
3940

4041
| Option | Default | Description |
4142
|------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|
42-
| background | White | Swagger UI iframe body background attribute value. You can use any css value for background for example "#74b9ff" or Gainsboro or "" for nothing. |
43+
| background | "" | Swagger UI iframe body background attribute value. You can use any css value for background for example "#74b9ff" or Gainsboro or "" for nothing. |
4344

4445
4. Add ```swagger-ui``` tag in markdown to include Swagger UI
4546

@@ -52,3 +53,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
5253
## License
5354

5455
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/Blueswen/mkdocs-swagger-ui-tag/blob/main/LICENSE) file for details.
56+
57+
## Reference
58+
59+
1. [Amoenus Swagger Dark Theme](https://github.com/Amoenus/SwaggerDark/): source of dark mode css

‎demo-mkdocs/docs/sample.png‎

-1.11 MB
Loading

‎demo-mkdocs/mkdocs.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,26 @@ theme:
1010
name: material
1111
features:
1212
- toc.integrate
13+
palette:
14+
# Palette toggle for automatic mode
15+
- media: "(prefers-color-scheme)"
16+
toggle:
17+
icon: material/brightness-auto
18+
name: Switch to light mode
19+
20+
# Palette toggle for light mode
21+
- media: "(prefers-color-scheme: light)"
22+
scheme: default
23+
toggle:
24+
icon: material/brightness-7
25+
name: Switch to dark mode
26+
27+
# Palette toggle for dark mode
28+
- media: "(prefers-color-scheme: dark)"
29+
scheme: slate
30+
toggle:
31+
icon: material/brightness-4
32+
name: Switch to system preference
1333

1434
markdown_extensions:
1535
- pymdownx.highlight:

‎docs/404.html‎

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212

1313

1414
<link rel="icon" href="/blueswen/mkdocs-swagger-ui-tag/assets/images/favicon.png">
15-
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.3.2+insiders-4.17.2">
15+
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.3.4+insiders-4.18.0">
1616

1717

1818

1919
<title>MkDocs Swagger UI Tag</title>
2020

2121

2222

23-
<link rel="stylesheet" href="/blueswen/mkdocs-swagger-ui-tag/assets/stylesheets/main.9b33a7c2.min.css">
23+
<link rel="stylesheet" href="/blueswen/mkdocs-swagger-ui-tag/assets/stylesheets/main.83929f28.min.css">
2424

2525

2626
<link rel="stylesheet" href="/blueswen/mkdocs-swagger-ui-tag/assets/stylesheets/palette.cbb835fc.min.css">
@@ -52,10 +52,12 @@
5252

5353

5454

55+
56+
5557

5658

5759

58-
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="none" data-md-color-accent="none">
60+
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="" data-md-color-accent="">
5961

6062

6163

@@ -68,7 +70,6 @@
6870

6971

7072

71-
7273
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
7374
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
7475
<label class="md-overlay" for="__drawer"></label>
@@ -110,6 +111,40 @@
110111
</div>
111112
</div>
112113

114+
<form class="md-header__option" data-md-component="palette">
115+
116+
117+
118+
<input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
119+
120+
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
121+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9h-1.9M20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69m-9.15 3.96h2.3L12 9l-1.15 3.65Z"/></svg>
122+
</label>
123+
124+
125+
126+
127+
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
128+
129+
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
130+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
131+
</label>
132+
133+
134+
135+
136+
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="" data-md-color-accent="" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
137+
138+
<label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
139+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
140+
</label>
141+
142+
143+
</form>
144+
145+
146+
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
147+
113148

114149

115150

@@ -343,10 +378,10 @@ <h1>404 - Not found</h1>
343378
<div class="md-dialog__inner md-typeset"></div>
344379
</div>
345380

346-
<script id="__config" type="application/json">{"base": "/blueswen/mkdocs-swagger-ui-tag/", "features": ["toc.integrate"], "search": "/blueswen/mkdocs-swagger-ui-tag/assets/javascripts/workers/search.16af1b4e.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>
381+
<script id="__config" type="application/json">{"base": "/blueswen/mkdocs-swagger-ui-tag/", "features": ["toc.integrate"], "search": "/blueswen/mkdocs-swagger-ui-tag/assets/javascripts/workers/search.bb370e14.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>
347382

348383

349-
<script src="/blueswen/mkdocs-swagger-ui-tag/assets/javascripts/bundle.fdb661c6.min.js"></script>
384+
<script src="/blueswen/mkdocs-swagger-ui-tag/assets/javascripts/bundle.ba7fc6cf.min.js"></script>
350385

351386

352387
</body>

docs/assets/javascripts/bundle.fdb661c6.min.js renamed to docs/assets/javascripts/bundle.ba7fc6cf.min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/javascripts/workers/search.16af1b4e.min.js renamed to docs/assets/javascripts/workers/search.bb370e14.min.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/stylesheets/main.83929f28.min.css‎

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

‎docs/assets/stylesheets/main.9b33a7c2.min.css‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)