Update docs

Author: blueswen

demo-mkdocs/docs/demo/openapi-v3.1.md

@@ -1,4 +1,4 @@
-Support using local OpenAPI Specification file on website.
+Support OpenAPI Specification v3.1.0.
 
 ## Markdown
 

demo-mkdocs/docs/demo/without-try-it-out.md

@@ -0,0 +1,21 @@
+Disable the "Try It Out" feature using the `supportedSubmitMethods` option. This is particularly useful for pure documentation purposes when there is no live backend server.
+
+## Markdown
+
+With local configurations:
+
+```html
+<swagger-ui supportedSubmitMethods="[]" src="./openapi-spec/sample.yaml"/>
+```
+
+With global configurations:
+
+```yaml
+plugins:
+  - swagger-ui:
+      supportedSubmitMethods: []
+```
+
+## Swagger UI
+
+<swagger-ui supportedSubmitMethods="[]" src="./openapi-spec/sample.yaml"/>

demo-mkdocs/docs/index.md

@@ -21,7 +21,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
 1. Python Package
     1. beautifulsoup4>=4.11.1
 2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
-    1. swagger-ui-dist==5.0.0-alpha.0
+    1. swagger-ui-dist==5.0.0
 
 ## Usage
 
@@ -59,12 +59,10 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
     | docExpansion | String | Default: "list". Controls the default expansion setting for the operations and tags. It can be "list" (expands only the tags), "full" (expands the tags and operations) or "none" (expands nothing). |
     | filter | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. |
     | syntaxHighlightTheme | String | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night" |
-    | tryItOutEnabled | Boolean | Default: False. Controls whether the "Try it out" section should be enabled by default. |
+    | tryItOutEnabled | Boolean | Default: False. This setting determines the default editability of the "Try it out" section, including parameters or body. |
     | 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. |
     | 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. |
-    | validatorUrl | String | Default: "none". By default, the validation is disabled. When setting with "https://validator.swagger.io/validator", 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)). |
-    | extra_css | Array | Default: []. Extra CSS files in your `docs_dir` included in Swagger UI iframe target html file. |
-    | dark_scheme_name | String | Default: "slate". Custom dark mode scheme name for [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). Check more details on [Material for MkDocs Documents](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/). |
+    | 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. |
 
 ## How it works
 

demo-mkdocs/docs/options.md

@@ -7,16 +7,16 @@ Some configurations on [Swagger UI Doc](https://swagger.io/docs/open-source-tool
 
 Supported configurations included:
 
-| Options                | Type              | Description                                                                                                                                                                                                                                                                                                                                                                                   |
-|------------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| background             | String            | Default: "". Swagger UI iframe body background attribute value. You can use any css value for background for example "#74b9ff" or "Gainsboro" or "" for nothing.                                                                                                                                                                                                                              |
-| docExpansion           | String            | Default: "list". Controls the default expansion setting for the operations and tags. It can be "list" (expands only the tags), "full" (expands the tags and operations) or "none" (expands nothing).                                                                                                                                                                                          |
-| filter                 | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag.                       |
-| syntaxHighlightTheme   | String            | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night"                                                                                                                                                                                                             |
-| tryItOutEnabled        | Boolean           | Default: False. Controls whether the "Try it out" section should be enabled by default.                                                                                                                                                                                                                                                                                                       |
-| 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.                        |
-| 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.                                                                                                       |
-| 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. |
+| Options | Type | Description |
+|---|---|---|
+| background | String | Default: "". Swagger UI iframe body background attribute value. You can use any css value for background for example "#74b9ff" or "Gainsboro" or "" for nothing. |
+| docExpansion | String | Default: "list". Controls the default expansion setting for the operations and tags. It can be "list" (expands only the tags), "full" (expands the tags and operations) or "none" (expands nothing). |
+| filter | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. |
+| syntaxHighlightTheme | String | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night" |
+| tryItOutEnabled | Boolean | Default: False. This setting determines the default editability of the "Try it out" section, including parameters or body. |
+| 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. |
+| 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. |
+| 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. |
 
 ## Through plugin options
 

demo-mkdocs/mkdocs.yml

@@ -68,4 +68,5 @@ nav:
     - Multiple: demo/multiple.md
     - Build-in Multiple: demo/build-in-multiple.md
     - OAuth2 Initialization: demo/oauth2.md
+    - Without Try It Out: demo/without-try-it-out.md
     - OpenAPI v3.1: demo/openapi-v3.1.md