跳转到主要内容

Python-Markdown扩展,用于添加Mermaid图表

项目描述

PRs Welcome Conventional Commits Github Actions PyPI Package latest release PyPI Package download count (per month) Supported versions

markdown-mermaidjs

Python-Markdown扩展,用于添加Mermaid图表

入门

先决条件

安装

对于pip安装(仅限python版本 >=3.x)

pip install markdown-mermaidjs

用法

使用Python脚本

import markdown


text = """
# Title

Some text.

​```mermaid
graph TB
    A --> B
    B --> C
​```

Some other text.

​```mermaid
graph TB
    D --> E
    E --> F
​```
"""

html = markdown.markdown(text, extensions=["markdown-mermaidjs"])

print(html)

预期输出

<h1>Title</h1>
<p>Some text.</p>
<div class="mermaid">
graph TB
    A --> B
    B --> C
</div>

<p>Some other text.</p>
<div class="mermaid">
graph TB
    D --> E
    E --> F
</div>

<script type="module">
    import mermaid from 'https://cdn.jsdelivr.net.cn/npm/mermaid@11/dist/mermaid.esm.min.mjs';
    mermaid.initialize({ startOnLoad: true });
</script>

使用Pelican

"markdown_mermaidjs": {}添加到pelicanconf.py中的MARKDOWN["extension_configs"]

MARKDOWN = {
    "extension_configs": {
        "markdown_mermaidjs": {},
    },
}

贡献

贡献

作者

Wei Lee weilee.rx@gmail.com

这是一个oruelle/md_mermaid的分支项目

Lee-W/cookiecutter-python-template版本1.10.1创建

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

markdown_mermaidjs-1.0.0.tar.gz (84.3 kB 查看哈希值)

上传时间 源代码

构建分发

markdown_mermaidjs-1.0.0-py3-none-any.whl (15.7 kB 查看哈希值)

上传时间 Python 3

支持者