An mdformat plugin for `gfm_alerts`.
Project description
mdformat-gfm-alerts
An mdformat plugin for GitHub "Alerts". "Alerts" are a block quote variation of admonitions that were proposed in this community discussion and are currently a separate extension of the GFM (GitHub-Flavored Markdown) syntax.
mdformat
Usage
Add this package wherever you use mdformat
and the plugin will be auto-recognized. No additional configuration necessary. See additional information on mdformat
plugins here
Pre-Commit
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
additional_dependencies:
- mdformat-gfm-alerts
pipx
pipx install mdformat
pipx inject mdformat mdformat-gfm-alerts
HTML Rendering
To generate HTML output, gfm_alerts_plugin
can be imported from mdit_plugins
. For more guidance on MarkdownIt
, see the docs: https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser
from markdown_it import MarkdownIt
from mdformat_gfm_alerts.mdit_plugins import gfm_alerts_plugin
md = MarkdownIt()
md.use(gfm_alerts_plugin)
text = "> [!NOTE]\n> Useful information that users should know, even when skimming content. "
md.render(text)
# <blockquote>
# <div class="markdown-alert markdown-alert-note">
# <p class="markdown-alert-title">Note</p>
# <p>Useful information that users should know, even when skimming content.</p>
# </div>
# </blockquote>
Warning
This package does not properly handle replacing the
blockquote
outerdiv
with adiv
for accessibility. This should be possible withmarkdown-it
, but I haven't yet found a way.
Contributing
See CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mdformat_gfm_alerts-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44941676b29b0bd90934d76617547d4464879ebd7980833461d7ae0e975a922b |
|
MD5 | a2b4dfe342862761365e0c87f855b848 |
|
BLAKE2b-256 | 1f989a9f05f3f00ee65c8aa9dbbd4cef1c61942dfa9631accfb664702c7ee8d7 |
Hashes for mdformat_gfm_alerts-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca5854921f700dca55dffda233564314545af9dda8fb05a64915ca305dc53469 |
|
MD5 | a7e01b8a89b143dd853e7d26b153c67b |
|
BLAKE2b-256 | fbb6726237108f1d5f77252c9ade49d3fde606878416c96e0d9ec678499ed09d |