A MkDocs plugin supports for add Swagger UI in page.
Project description
MkDocs swagger-ui-tag
A MkDocs plugin supports for add Swagger UI in page.
Live demo with mkdocs-material theme.
Features
- Multiple OpenAPI Specification file source: url, static file in docs
- Multiple Swagger UI in same page
Dependency
- Python Package
- beautifulsoup4==4.11.1
- Swagger UI dist javascript file and css file
- swagger-ui-dist==4.12.0
Usage
-
Install plugin from pypi
pip install mkdocs-swagger-ui-tag
-
Add
swagger-ui-tag
plugin in to your mkdocs.yml plugins sections:plugins: - swagger-ui-tag
-
You may customize the plugin by passing options in mkdocs.yml:
plugins: - swagger-ui-tag: background: White
Option Default Description 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. -
Add
swagger-ui
tag in markdown to include Swagger UI<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for mkdocs-swagger-ui-tag-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f9f311b4df1acb6fe4cfdb7779b218816c66f25885b2b5d201d2b1ff28a3f6b |
|
MD5 | 23b3b45f0183f580f3770c34c7e34175 |
|
BLAKE2b-256 | 14afe969512e3306d6fb790134d91bdfafe2184ba1bb1656a846f4c479881a06 |