Skip to content

Commit ee2c425

Browse files
committed
Release 0.7.2
1 parent b51e452 commit ee2c425

File tree

4 files changed

+13
-8
lines changed

4 files changed

+13
-8
lines changed

CHANGELOG

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
mkdocs-swagger-ui-tag 0.7.2 (2025-08-24)
2+
3+
* Updated swagger-ui-dist to 5.27.1 (#36)
4+
15
mkdocs-swagger-ui-tag 0.7.1 (2025-05-04)
26

37
* Updated swagger-ui-dist to 5.21.0

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,9 @@ A MkDocs plugin supports adding [Swagger UI](https://github.com/swagger-api/swag
7272
| oauth2RedirectUrl | String | Default: Absolute URL of "/assets/swagger-ui/oauth2-redirect.html" relative with site_url in mkdocs.yml or document root path on site without site_url, e.g. "[https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html](https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html)". OAuth redirect URL. |
7373
| supportedSubmitMethods | Array | Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display. |
7474
| validatorUrl | String | Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it "none" to disable validation. |
75-
76-
77-
Add dark_scheme_name
78-
extra_css
79-
filter_files
75+
| extra_css | Array | Default: []. List of additional CSS files to include in Swagger UI iframes. |
76+
| dark_scheme_name | String | Default: "slate". The color scheme name used for dark mode detection with Material for MkDocs theme. |
77+
| filter_files | Array | Default: []. List of file paths to filter processing. If specified, only files in this list will be processed for swagger-ui tags. |
8078
8179
## How it works
8280

demo-mkdocs/docs/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A MkDocs plugin supports adding [Swagger UI](https://github.com/swagger-api/swag
2121
1. Python Package
2222
1. beautifulsoup4>=4.13.3
2323
2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and CSS file
24-
1. swagger-ui-dist==5.21.0
24+
1. swagger-ui-dist==5.27.1
2525

2626
## Usage
2727

@@ -64,10 +64,13 @@ A MkDocs plugin supports adding [Swagger UI](https://github.com/swagger-api/swag
6464
| oauth2RedirectUrl | String | Default: Absolute URL of "/assets/swagger-ui/oauth2-redirect.html" relative with site_url in mkdocs.yml or document root path on site without site_url, e.g. "[https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html](https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html)". OAuth redirect URL. |
6565
| supportedSubmitMethods | Array | Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display. |
6666
| validatorUrl | String | Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it "none" to disable validation. |
67+
| extra_css | Array | Default: []. List of additional CSS files to include in Swagger UI iframes. |
68+
| dark_scheme_name | String | Default: "slate". The color scheme name used for dark mode detection with Material for MkDocs theme. |
69+
| filter_files | Array | Default: []. List of file paths to filter processing. If specified, only files in this list will be processed for swagger-ui tags. |
6770
6871
## How it works
6972
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
73+
1. Copies 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
7174
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
7275
7376
## License

uv.lock

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)