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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c11f837ac16ac7414331887a2df4b66175b68155077d56887e713661782141de |
|
MD5 | 48f86987f17f448d244fefb47efb4c70 |
|
BLAKE2b-256 | e748c4d0a3cad540b3815f2edd32e19d2c8a967a4a2cefc2d3c393c92c60f076 |
Hashes for mdformat_gfm_alerts-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bc382daf004088bc7b848db22fdf43df4383454a161db5cbbbd0472877b1a53 |
|
MD5 | f1daa05a1011f1f8546629f2e56c3896 |
|
BLAKE2b-256 | 54c8a8018b5cdb312e5ce455bb509bcb045f455ec2379c43d10597d67bd7448b |