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-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f1c9ee6f955a2b39b0ee1367c7a87344d75b9c2b35862bf11ca6df74871aa05 |
|
MD5 | 1ba134a54557dc1b34237f4b19e0f3ab |
|
BLAKE2b-256 | fd1709d16b0808d8b14c65efdf0898bf82aed8d272316be4d9d800f356ec2371 |
Hashes for mdformat_gfm_alerts-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99c59f99cbb85f59e993e34da28bf09613b2dd2fe1d28747ac44c88f98b4f151 |
|
MD5 | b13bc75124c26d24439aec64225753d1 |
|
BLAKE2b-256 | 0cea0fb0b27f71f06b90613d3829ae1f44d1f43670231d1eb4db238f55a3011d |