{"id":16729054,"url":"https://github.com/kyleking/mdformat-gfm-alerts","last_synced_at":"2025-04-10T11:09:11.021Z","repository":{"id":226699335,"uuid":"769353936","full_name":"KyleKing/mdformat-gfm-alerts","owner":"KyleKing","description":"Format \"GitHub Markdown Alerts,\" which use blockquotes to render admonitions","archived":false,"fork":false,"pushed_at":"2024-12-16T01:35:05.000Z","size":90,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-01T22:13:06.843Z","etag":null,"topics":["mdformat"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KyleKing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-08T21:50:21.000Z","updated_at":"2025-02-23T01:31:52.000Z","dependencies_parsed_at":"2024-06-25T00:38:47.331Z","dependency_job_id":"35c787e0-7f77-4c52-8bce-c42c3fa8102a","html_url":"https://github.com/KyleKing/mdformat-gfm-alerts","commit_stats":null,"previous_names":["kyleking/mdformat-gfm-alerts"],"tags_count":3,"template":false,"template_full_name":"executablebooks/mdformat-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleKing%2Fmdformat-gfm-alerts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleKing%2Fmdformat-gfm-alerts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleKing%2Fmdformat-gfm-alerts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KyleKing%2Fmdformat-gfm-alerts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KyleKing","download_url":"https://codeload.github.com/KyleKing/mdformat-gfm-alerts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208550,"owners_count":21065202,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mdformat"],"created_at":"2024-10-12T23:13:07.344Z","updated_at":"2025-04-10T11:09:11.005Z","avatar_url":"https://github.com/KyleKing.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdformat-gfm-alerts\n\n[![Build Status][ci-badge]][ci-link] [![PyPI version][pypi-badge]][pypi-link]\n\nAn [mdformat](https://github.com/executablebooks/mdformat) plugin for `\u003cplaceholder\u003e`\n\n## `mdformat` Usage\n\nAdd this package wherever you use `mdformat` and the plugin will be auto-recognized. No additional configuration necessary. See [additional information on `mdformat` plugins here](https://mdformat.readthedocs.io/en/stable/users/plugins.html)\n\n### Pre-Commit\n\n```yaml\nrepos:\n  - repo: https://github.com/executablebooks/mdformat\n    rev: 0.7.18\n    hooks:\n      - id: mdformat\n        additional_dependencies:\n          - mdformat-gfm-alerts\n```\n\n### pipx/uv\n\n```sh\npipx install mdformat\npipx inject mdformat mdformat-gfm-alerts\n```\n\nOr with uv:\n\n```sh\nuv tool run --from mdformat-gfm-alerts mdformat\n```\n\n## HTML Rendering\n\nTo generate HTML output, `gfm_alerts_plugin` can be imported from `mdit_plugins`. For more guidance on `MarkdownIt`, see the docs: \u003chttps://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser\u003e\n\n```py\nfrom markdown_it import MarkdownIt\n\nfrom mdformat_gfm_alerts.mdit_plugins import gfm_alerts_plugin\n\nmd = MarkdownIt()\nmd.use(gfm_alerts_plugin)\n\ntext = \"... markdown example ...\"\nmd.render(text)\n# \u003cdiv\u003e\n#\n# \u003c/div\u003e\n```\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/kyleking/mdformat-gfm-alerts/blob/main/CONTRIBUTING.md)\n\n[ci-badge]: https://github.com/kyleking/mdformat-gfm-alerts/workflows/CI/badge.svg?branch=main\n[ci-link]: https://github.com/kyleking/mdformat-gfm-alerts/actions?query=workflow%3ACI+branch%3Amain+event%3Apush\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-gfm-alerts.svg\n[pypi-link]: https://pypi.org/project/mdformat-gfm-alerts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkyleking%2Fmdformat-gfm-alerts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkyleking%2Fmdformat-gfm-alerts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkyleking%2Fmdformat-gfm-alerts/lists"}