用于在Markdown文件中执行代码块的工具。
项目描述
Markdown Exec
用于在Markdown文件中执行代码块的工具。
例如，您编写一个Python代码块来计算一些HTML，然后将此HTML注入到代码块所在位置。
安装
使用 pip
pip install markdown-exec[ansi]
ansi 额外功能提供了必要的位（pygments-ansi-color 和 CSS 文件）以在HTML代码块中渲染ANSI颜色。当通过 plugins（见下文）激活 Markdown Exec 时，CSS 文件将自动添加到 MkDocs 的 extra_css 中。
配置
此扩展依赖于 PyMdown Extensions 的 SuperFences 扩展。
为了允许执行代码块，请使用 Python 配置自定义围栏
from markdown import Markdown
from markdown_exec import formatter, validator
Markdown(
extensions=["pymdownx.superfences"],
extension_configs={
"pymdownx.superfences": {
"custom_fences": [
{
"name": "python",
"class": "python",
"validator": validator,
"format": formatter,
}
# ...one fence for each language we support:
# bash, console, md, markdown, py, python, pycon, sh, tree
]
}
}
)
...或者在 MkDocs 配置文件中，作为 Markdown 扩展
# mkdocs.yml
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: python
class: python
validator: !!python/name:markdown_exec.validator
format: !!python/name:markdown_exec.formatter
# ...one fence for each language we support:
# bash, console, md, markdown, py, python, pycon, sh, tree
...或者在 MkDocs 配置文件中，作为插件
# mkdocs.yml
plugins:
- search
- markdown-exec
# SuperFences must still be enabled!
markdown_extensions:
- pymdownx.superfences
我们强烈建议如果你使用 MkDocs，则启用 Markdown Exec 插件：它将在需要时负责向最终网站添加相关资产（CSS/JS）。
用法
你现在可以执行代码块而不是显示它们
```python exec="on"
print("Hello Markdown!")
```
exec 选项对于除了 0、no、off 和 false（不区分大小写）之外的所有可能的值都将是 true。
以下是一个运行预期返回非零退出码的 bash 脚本的示例
```bash exec="1" source="tabbed-left" returncode="2"
grep extra_css README.md && exit 2
```
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关 安装包 的更多信息。
源分布
markdown_exec-1.9.3.tar.gz (74.7 kB 查看散列)
构建分布
markdown_exec-1.9.3-py3-none-any.whl (27.3 kB 查看散列)
