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
- OpenAPI Specification file from online over URL or static file in docs
- Multiple Swagger UI in same page
- Synchronized dark mode with mkdocs-material
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 "" 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.
Reference
- Amoenus Swagger Dark Theme: source of dark mode css
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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 251a8161667595c9255b4db3377aa39cd0f6a3b9c1bf21272bf031d35ffc57b0 |
|
MD5 | c6b254a1abf102b3a08dbdb3e1775724 |
|
BLAKE2b-256 | e4f71fab9c8a3fc4141ca353ff07f22e155d0ad2eed19b9b75492ae3af7f38ec |