{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"Renders Swagger and OpenAPI schemas as interactive documentation within MkDocs sites using Swagger UI, supporting both local JSON files and external URLs.","skillfed_tags":["api-documentation","openapi","mkdocs-plugin"],"use_cases":["Embed interactive API documentation directly in your project's MkDocs site without maintaining separate documentation portals.","Display OpenAPI schemas generated by FastAPI or similar frameworks as part of your technical documentation.","Reference multiple API specifications from different sources (local files or external URLs) within a single documentation site.","Customize Swagger UI appearance by providing your own CSS and JavaScript assets instead of relying on the CDN."],"what_it_does":"mkdocs-render-swagger-plugin is an MkDocs plugin that embeds interactive Swagger UI documentation directly into your MkDocs site by rendering OpenAPI and Swagger JSON schemas. It works by inserting special markup tags into your markdown files\u2014either `!!swagger FILENAME!!` for local JSON files or `!!swagger-http URL!!` for external schemas\u2014which the plugin then converts into fully interactive API documentation at build time.\n\nThe plugin uses Swagger UI from a CDN by default but allows you to specify custom JavaScript and CSS assets if needed. It integrates with the MkDocs plugin system and respects the OpenAPI specification standard, making it compatible with schemas generated by tools like FastAPI and Pydantic. However, the project is currently dormant with no active maintenance, so it may not receive updates for compatibility issues with newer mkdocs or OpenAPI versions.","worth_installing":"Yes, if you are building MkDocs documentation and want to embed interactive OpenAPI/Swagger schemas with minimal setup. The low install friction and permissive license make it straightforward to add. However, be aware that maintenance is dormant\u2014if you encounter issues or need support for newer OpenAPI versions, you may need to fork or patch the plugin yourself. Suitable for stable, self-contained documentation projects."},"id":"mkdocs-render-swagger-plugin","links":{"html":"https://skillfed.io/packages/mkdocs-render-swagger-plugin","md":"https://skillfed.io/packages/mkdocs-render-swagger-plugin.md","pypi":"https://pypi.org/project/mkdocs-render-swagger-plugin/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2024-05-26","license_spdx":null,"license_treatment":"permissive","name":"mkdocs-render-swagger-plugin","python_support":"supports_current","summary":"MKDocs plugin for rendering swagger & openapi files."},"popularity":{"monthly_downloads":149151,"position":11002,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.1.2"}