为 Markdown 文件生成或插入目录。
项目描述
降价-toc-cli
将目录插入到 Markdown 文件中。
深受这个项目的启发： https ://github.com/hukkin/mdformat-toc
我建议使用它，除非您不想运行内置mdformat
格式。那么这个工具可能适用于独立版本。
安装
pip install markdown-toc-cli
用法
在 Markdown 文件中添加这样的注释：
<!-- markdown-toc-cli --prefix='- ' --indentation=' ' --minlevel=1 --maxlevel=6 -->
所有参数都是可选的，默认值如上所示（与 GitHub 风格的降价兼容）。
然后运行该工具：
markdown-toc-cli README.md
预提交钩子
将此作为预提交挂钩的示例用法：
- repo: https://github.com/noahp/markdown-toc-cli
rev: 0.1.1
hooks:
- id: markdown-toc-cli
