Skip to content

Commit 663400d

Browse files
committed
Update docs
1 parent 175035a commit 663400d

36 files changed

+105
-102
lines changed

demo-mkdocs/docs/index.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,40 @@
44
<a target="_blank" href="https://pypi.org/project/mkdocs-swagger-ui-tag"><img src="https://img.shields.io/pypi/dm/mkdocs-swagger-ui-tag.svg" alt="PyPI downloads"/></a>
55
<a target="_blank" href="https://codecov.io/gh/blueswen/mkdocs-swagger-ui-tag"><img src="https://codecov.io/gh/blueswen/mkdocs-swagger-ui-tag/branch/main/graph/badge.svg?token=1D1B0GAQN1" alt="Codecov"/></a>
66

7-
A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swagger-ui) in page.
7+
A MkDocs plugin supports adding [Swagger UI](https://github.com/swagger-api/swagger-ui) to the page.
88

99
## Features
1010

1111
1. OpenAPI Specification file from online over URL or static file in docs
12-
2. All dependencies are using static files handled by plugin not from CDN, especially suitable for those documents been deployed in the intranet
13-
3. Multiple Swagger UI in same page
12+
2. All dependencies are using static files handled by the plugin not from CDN, especially suitable for those documents been deployed in the intranet
13+
3. Multiple Swagger UI on the same page
1414
4. Synchronized dark mode with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
1515
5. Configure [Swagger UI configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) through plugin options and tag attributes
16-
6. Support multiple OAS in single Swagger UI with top bar selector
16+
6. Support multiple OAS in a single Swagger UI with a top bar selector
1717
7. Support Swagger UI [initOAuth](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/) method
1818

1919
## Dependency
2020

2121
1. Python Package
2222
1. beautifulsoup4>=4.11.1
23-
2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
24-
1. swagger-ui-dist==5.10.0
23+
2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and CSS file
24+
1. swagger-ui-dist==5.11.0
2525

2626
## Usage
2727

28-
1. Install plugin from pypi
28+
1. Install the plugin from PyPI
2929

3030
```bash
3131
pip install mkdocs-swagger-ui-tag
3232
```
3333

34-
2. Add ```swagger-ui-tag``` plugin in to your mkdocs.yml plugins sections:
34+
2. Add ```swagger-ui-tag``` plugin to your mkdocs.yml plugins sections:
3535

3636
```yaml
3737
plugins:
3838
- swagger-ui-tag
3939
```
40+
4041
3. Add ```swagger-ui``` tag in markdown to include Swagger UI
4142

4243
```html
@@ -66,8 +67,8 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
6667
6768
## How it works
6869
69-
1. Copy Swagger UI script file into `site/assets/javascripts/` directory, CSS file into `site/assets/stylesheets/` directory, and the [default Oauth2 redirect html](https://github.com/blueswen/mkdocs-swagger-ui-tag/blob/main/mkdocs_swagger_ui_tag/swagger-ui/oauth2-redirect.html) into `site/assets/swagger-ui/` directory
70-
2. Search all swagger-ui tags, then convert them to an iframe tag and generate the iframe target html with the given OpenAPI Specification src path and options
70+
1. Copy the Swagger UI script file into `site/assets/javascripts/` directory, the CSS file into `site/assets/stylesheets/` directory, and the [default Oauth2 redirect html](https://github.com/blueswen/mkdocs-swagger-ui-tag/blob/main/mkdocs_swagger_ui_tag/swagger-ui/oauth2-redirect.html) into `site/assets/swagger-ui/` directory
71+
2. Search all swagger-ui tags, then convert them to an iframe tag and generate the iframe target HTML with the given OpenAPI Specification src path and options
7172
7273
## License
7374

docs/404.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@
1515

1616

1717
<link rel="icon" href="/mkdocs-swagger-ui-tag/assets/images/favicon.png">
18-
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.6+insiders-4.42.2">
18+
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.11+insiders-4.44.0">
1919

2020

2121

2222
<title>MkDocs Swagger UI Tag</title>
2323

2424

2525

26-
<link rel="stylesheet" href="/mkdocs-swagger-ui-tag/assets/stylesheets/main.62ccb7e6.min.css">
26+
<link rel="stylesheet" href="/mkdocs-swagger-ui-tag/assets/stylesheets/main.0ab26e37.min.css">
2727

2828

2929
<link rel="stylesheet" href="/mkdocs-swagger-ui-tag/assets/stylesheets/palette.ab4e12ef.min.css">
@@ -664,7 +664,7 @@ <h1>404 - Not found</h1>
664664
<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.1e90e0fb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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": "Select version"}}</script>
665665

666666

667-
<script src="/mkdocs-swagger-ui-tag/assets/javascripts/bundle.59e7e423.min.js"></script>
667+
<script src="/mkdocs-swagger-ui-tag/assets/javascripts/bundle.6981e6db.min.js"></script>
668668

669669

670670
</body>

docs/assets/javascripts/bundle.59e7e423.min.js renamed to docs/assets/javascripts/bundle.6981e6db.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/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/javascripts/swagger-ui-standalone-preset.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-standalone-preset.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/main.62ccb7e6.min.css renamed to docs/assets/stylesheets/main.0ab26e37.min.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.

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.

docs/assets/stylesheets/swagger-ui.css.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.

0 commit comments

Comments
 (0)