{"repo":"blueswen/mkdocs-swagger-ui-tag","free":true,"listed":false,"github":"https://github.com/blueswen/mkdocs-swagger-ui-tag","clone":"git clone https://github.com/blueswen/mkdocs-swagger-ui-tag.git","description":"A MkDocs plugin supports adding Swagger UI to the page.","language":"Python","stars":113,"topics":["mkdocs","mkdocs-plugin","openapi","swagger-ui","openapi3"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"MkDocs Swagger UI Tag A MkDocs plugin supports adding Swagger UI to the page. Live demo with Material for MkDocs. Features 1. OpenAPI Specification file from online over URL or static file in docs 2. All dependencies are using static files handled by the plugin not from CDN, especially suitable for those documents been deployed in the intranet 3. Multiple Swagger UI on the same page 4. Synchronized dark mode with Material for MkDocs 5. Configure Swagger UI configuration through plugin options and tag attributes 6. Support multiple OAS in a single Swagger UI with a top bar selector 7. Support Swagger UI initOAuth method Dependency 1. Python Package 1. beautifulsoup4 =4.13.3 2. Swagger UI dist javascript file and CSS file 1. swagger-ui-dist==5.32.8 Usage 1. Install the plugin from PyPI 2. Add plugin to your mkdocs.yml plugins sections: 3. Add tag in markdown to include Swagger UI 4. You may customize the plugin by passing options in mkdocs.yml, check more details on options: 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","default_branch":null,"files":null,"tree":[],"storefront":"/r/blueswen","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/blueswen/mkdocs-swagger-ui-tag/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}