{"id":21578,"library":"mkdocs-render-swagger-plugin","title":"MkDocs Render Swagger Plugin","description":"MkDocs plugin for rendering Swagger & OpenAPI specification files in documentation pages. Current version 0.1.2, supporting Swagger-UI v5. Released on PyPI, actively maintained.","status":"active","version":"0.1.2","language":"python","source_language":"en","source_url":"https://github.com/bharel/mkdocs-render-swagger-plugin","tags":["mkdocs","plugin","swagger","openapi","documentation"],"install":[{"cmd":"pip install mkdocs-render-swagger-plugin","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"The package's main class is SwaggerUI, used internally; no direct user import typically required.","symbol":"SwaggerUI","correct":"from mkdocs_render_swagger_plugin import SwaggerUI"}],"quickstart":{"code":"# In mkdocs.yml:\n# plugins:\n#   - render_swagger\n\n# In a markdown page:\n# :swagger: path/to/openapi.yaml\n\n# Example usage with env variable:\n# :swagger: https://petstore.swagger.io/v2/swagger.json\n","lang":"yaml","description":"Add the plugin to mkdocs.yml, then use the :swagger: tag in markdown files to embed an OpenAPI spec."},"warnings":[{"fix":"Review Swagger-UI 5 migration guide; update any custom assets or styling.","message":"Version 0.1.0 bumped Swagger-UI to major version 5, which may break customizations relying on internal CSS or JS selectors.","severity":"breaking","affected_versions":">=0.1.0"},{"fix":"In mkdocs.yml, use 'plugins: [render_swagger]' or the full import path as configured.","message":"The plugin uses the package name 'mkdocs-render-swagger-plugin' but the entry point in mkdocs.yml is 'render_swagger' (with underscores).","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Use 'render_swagger' in plugins list, matching the plugin's entry point.","cause":"mkdocs.yml uses hyphenated name instead of underscore.","error":"Plugin 'render-swagger' not found"},{"fix":"Run 'pip install mkdocs-render-swagger-plugin' and activate the correct Python environment.","cause":"Package not installed or installed in wrong environment.","error":"No module named 'mkdocs_render_swagger_plugin'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}