{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"A MkDocs plugin that converts GitHub-flavored admonitions (using `> [!TYPE]` syntax) to MkDocs-compatible admonitions so the same markdown renders correctly in both GitHub and built documentation.","skillfed_tags":["markdown-conversion","github-compat"],"use_cases":["Write documentation in a single markdown source that displays admonitions correctly on GitHub and in your built MkDocs site without duplication.","Migrate existing GitHub README admonitions into MkDocs documentation while keeping the same markdown syntax.","Maintain consistent admonition styling across GitHub-hosted projects and their generated documentation sites.","Use GitLab alerts in markdown and have them automatically converted for MkDocs builds."],"what_it_does":"This is a MkDocs plugin that solves a markdown compatibility problem: GitHub and MkDocs each support admonitions, but with incompatible syntax. GitHub uses `> [!TYPE]` blocks while MkDocs uses `!!! type` blocks. The plugin intercepts your markdown during the build process and converts GitHub-style admonitions to MkDocs syntax, so you can write admonitions once in GitHub's format and have them render correctly in both places.\n\nThe plugin supports GitHub's admonition types (note, tip, important, warning, caution) and also GitLab alerts. It handles edge cases like mixed case types and preserves content including inline code and nested lists. Two GitHub types (caution, important) map to MkDocs equivalents (danger, warning) with the original title preserved. The plugin is lightweight, depending only on mkdocs itself, and requires Python 3.8 or later.","worth_installing":"Yes, if you maintain documentation in both GitHub and MkDocs. The plugin solves a real friction point\u2014write-once admonitions that work everywhere\u2014with low install friction and no security concerns. The aging maintenance status (438 days since last release) is not a blocker for a stable, focused tool, but verify it still works with your MkDocs version before relying on it for a new project."},"id":"mkdocs-github-admonitions-plugin","links":{"html":"https://skillfed.io/packages/mkdocs-github-admonitions-plugin","md":"https://skillfed.io/packages/mkdocs-github-admonitions-plugin.md","pypi":"https://pypi.org/project/mkdocs-github-admonitions-plugin/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-06-02","license_spdx":null,"license_treatment":"permissive","name":"mkdocs-github-admonitions-plugin","python_support":"supports_current","summary":"Convert GitHub admonitions to mkdocs syntax when building docs."},"popularity":{"monthly_downloads":472596,"position":6475,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.1.1"}