mdit-py-toc

基于 markdown-it-py 和 markdown-it-toc-done-right 的Markdown目录插件。

• 安装
  • 使用poetry安装
  • 使用pip安装
• 选项
• 使用方法

安装

使用poetry安装

由于 mdit-py-toc 是一个插件，您可能需要一个工具来处理Python包依赖项和Python环境。因此，我们强烈建议使用 poetry。

您可以使用 poetry 安装最新稳定版本并将其添加到当前项目的依赖项中。

poetry add mdit-py-toc

使用pip安装

[!注意] 由于 PEP 668，在像Ubuntu >= 23.04这样的新发行版中，pip install 命令不再默认工作。

您可以使用 pip 从Python包索引（pypi）安装最新稳定版本。

python -m pip install mdit-py-toc

选项

使用方法

mdit-py-toc 与 锚点插件 结合使用效果最佳。

from markdown_it import MarkdownIt
from mdit_py_plugins.anchors import anchors_plugin
from mdit_py_toc import toc_plugin, slugify

md = (
  MarkdownIt()
  .use(anchors_plugin, permalink=True, slug_func=slugify)
  .use(toc_plugin, list_type="ol")
)
markdown = """
# A Page

[TOC]

## Section 1

## Section 2
"""
html = md.render(markdown)

生成以下 HTML 输出

<h1 id="a-page">A Page <a class="header-anchor" href="#a-page">¶</a></h1>
<nav>
<ol>
<li><a href="#a-page">A Page </a><ol>
<li><a href="#section-1">Section 1 </a></li>
<li><a href="#section-2">Section 2 </a></li>
</ol></li>
</ol></nav>
<h2 id="section-1">Section 1 <a class="header-anchor" href="#section-1">¶</a></h2>
<h2 id="section-2">Section 2 <a class="header-anchor" href="#section-2">¶</a></h2>