mkdocs-swagger-ui-tag
A MkDocs plugin supports for add Swagger UI in page.
Decision gist · record as of 2026-08-14
Yes. The plugin is actively maintained, has no known vulnerabilities, installs with minimal friction, and solves a real problem for teams documenting APIs in MkDocs. It's particularly valuable if you want to avoid hosting Swagger UI separately or need to serve API docs in restricted network environments.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires MkDocs to be installed and a valid mkdocs.yml configuration file in your project.
- Low friction install with a single runtime dependency (beautifulsoup4).
- Active maintenance with a recent release (35 days ago) and steady repository activity.
License · maintenance · safety
MIT (permissive) — MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
last release 2026-07-10 (35 days) · last repo commit 2026-07-10 · 113 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 283,110 downloads/mo, #8,080 on PyPI
Alternatives
Verify before relying
pip install mkdocs-swagger-ui-tag
Add to mkdocs.yml:
plugins:
- swagger-ui-tag
In markdown:
<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>- Whether the plugin requires Node.js or npm to be installed separately for Swagger UI dist files
- Compatibility with MkDocs versions beyond the Python version support range
What it is and what it does
This plugin extends MkDocs by allowing you to embed interactive Swagger UI viewers directly into your documentation pages using a simple HTML tag. Instead of linking to external API documentation or hosting Swagger UI separately, you add a `<swagger-ui>` tag pointing to an OpenAPI specification file—either a remote URL or a local file in your docs folder—and the plugin converts it into an embedded iframe with full Swagger UI functionality.
The plugin handles all the heavy lifting: it copies Swagger UI's JavaScript and CSS assets into your site's static directories, generates the necessary iframe HTML, and supports multiple Swagger UIs on the same page. It integrates with Material for MkDocs' dark mode, lets you configure Swagger UI behavior through plugin options (like operation expansion, syntax highlighting theme, and Try It Out settings), and supports OAuth2 flows. All assets are served locally rather than from a CDN, making it suitable for intranet deployments.
Use it for
- Embed API documentation directly in MkDocs sites alongside other guides and tutorials without maintaining separate Swagger UI hosting.
- Display multiple OpenAPI specs in one documentation site with a selector bar to switch between them.
- Support OAuth2-protected API testing in embedded Swagger UI with configurable redirect URLs.
- Serve Swagger UI entirely from local assets in air-gapped or intranet environments without CDN access.
- Customize Swagger UI appearance and behavior per-page through tag attributes while keeping global defaults in mkdocs.yml.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The plugin is actively maintained, has no known vulnerabilities, installs with minimal friction, and solves a real problem for teams documenting APIs in MkDocs. It's particularly valuable if you want to avoid hosting Swagger UI separately or need to serve API docs in restricted network environments.
Install
mkdocs-swagger-ui-tag on PyPI
Before you install
Low friction install with a single runtime dependency (beautifulsoup4). Active maintenance with a recent release (35 days ago) and steady repository activity.
Requires MkDocs to be installed and a valid mkdocs.yml configuration file in your project.
License in practice
MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.
Quickstart
pip install mkdocs-swagger-ui-tag
Add to mkdocs.yml:
plugins:
- swagger-ui-tag
In markdown:
<swagger-ui src="https://petstore.swagger.io/v2/swagger.json"/>Verify before relying
- Whether the plugin requires Node.js or npm to be installed separately for Swagger UI dist files
- Compatibility with MkDocs versions beyond the Python version support range
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.8 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagebeautifulsoup4 |
| Maintenance | Actively maintained 35 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 283,110 / month, #8,080 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Text Processing |
Evidence: mkdocs_swagger_ui_tag-0.8.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs swagger ui plugin”
- mkdocs-swagger-ui-tagA MkDocs plugin that embeds Swagger UI directly into documentation…
- mkdocs-render-swagger-pluginRenders Swagger and OpenAPI schemas as interactive documentation…
- neoteroi-mkdocsProvides a collection of MkDocs plugins and Markdown extensions for…
Give your agent the search over MCP, or paste the wish link into any chat.
More Text Processing packages
A drop-in replacement for Python's standard `re` module that adds advanced regex features like nested sets, fuzzy matching, lookaround in conditionals, and full Unicode case-folding while maintaining backward compatibility.
pyparsing provides a library for building text parsers directly in Python code using composable grammar classes, handling quoted strings, whitespace variation, and embedded comments without regex or lex/yacc.
Install it if you need to parse text or define grammars programmatically.
fonttools manipulates font files in multiple formats (TrueType, OpenType, AFM, Type 1, Mac-specific) and includes TTX, a tool to convert fonts to and from XML text format.
Install it if you need to read, write, or manipulate fonts programmatically or via the TTX command-line tool.
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
RapidFuzz provides fast fuzzy string matching using Levenshtein Distance and related metrics, implemented mostly in C++ with Python bindings for rapid similarity scoring and approximate string matching.
Install it if you need fuzzy string matching; it's a solid replacement for FuzzyWuzzy with better licensing and performance.
tinycss2 parses CSS strings into token and block objects, and generates CSS strings from those objects, following the CSS Syntax Level 3 specification without enforcing specific properties or values.
Install it if your project requires CSS tokenization or syntax manipulation.
See also mkdocs-render-swagger-plugin · swagger-plugin-for-sphinx · swagger-ui-py · aiohttp-swagger · flask-swagger-ui · neoteroi-mkdocs · mkdocs-glightbox · swagger-ui-bundle · essentials-openapi · fastapi-offline