一个用于admonitions的mdformat插件。
项目描述
mdformat-admon
一个用于 admonitions 的mdformat插件，一组支持新admonition语法的辅助工具，以及用于渲染admonition HTML的工具。
mdformat 使用方法
在任何使用mdformat的地方添加此包，插件将自动识别。无需额外配置。有关mdformat插件的更多信息，请参阅此处
Pre-Commit
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
additional_dependencies:
- mdformat-admon
pipx
pipx install mdformat
pipx inject mdformat mdformat-admon
HTML 渲染
要生成HTML输出，可以从mdit_plugins导入python_markdown_admon_plugin。将来还将添加更多插件。有关MarkdownIt的更多指导，请参阅文档： https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser
from markdown_it import MarkdownIt
from mdformat_admon.mdit_plugins import python_markdown_admon_plugin
md = MarkdownIt()
md.use(python_markdown_admon_plugin)
text = '!!! note ""\n *content*'
md.render(text)
# <div class="admonition note">
# <p><em>content</em></p>
# </div>
可扩展性
由于admonition语法在各种实现之间差异很大，因此该包在mdformat_admon.factories下提供一组用于构建新admonition解析器的辅助工具。
- 由
mdformat-admon支持 - 由其他包支持
- 目前不支持（或者至少不知道是否支持）
查看不同劝诫格式在此测试文件中的处理方式： ./tests/pre-commit-test.md
贡献
关闭
mdformat_admon-2.0.6.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 009aa1c5e171cf03ee65588579e7f5310929a67712127020a0369a645339f0e8 |
|
| MD5 | acb4b487ec09beaff3a873fe00935f29 |
|
| BLAKE2b-256 | f17f4e3aa626b04a16e466cabb0143b644ba13677182c0f37e3afed4e569e28a |
关闭
mdformat_admon-2.0.6-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 2fda60659d11210d6cb07ee0df11bf68bae84f75bbd471de8b786accdb674ede |
|
| MD5 | 0feb4886b3c64a76a77fae603227edd5 |
|
| BLAKE2b-256 | 0d4524d1799a7eedcfa4e26b4b8503694618420195f35448e591f2687e0d062b |
