md-toc 6.0.0

视频

说明

此程序生成的目录（也称为toc）旨在 使用几个标记解析器，比如github和gitlab使用的那些。

当与in-place选项一起使用时，此脚本将在第一次使用时写入toc 标记物的出现。默认标记是<!--TOC-->，它是 一个HTML注释，在标记文件 被翻译了。

默认情况下，标题最多有三个缩进级别（在html中：h1，h2， h3）将包含在目录中，但用户可以决定保留所有 可能的水平。

md_-toc使得生成有序和无序的toc成为可能。 在这两种情况下，toc的每个元素在默认情况下都是 链接到网页中的段落。也可以生成 目录的非链接版本。

如果用户需要，可以忽略空格缩进 在目录中，跳过标记文件中的初始行数。

生成目录的规则由选定的 标记分析器。MD TOC旨在尽可能符合 尊重他们每个人。通过研究现有的 文件和通过逆向工程的源代码。

文档

http://frnmst.github.io/md-toc

请仔细阅读文档的Markdown specification部分 以了解此程序解析器如何标记文件并生成正确的输出。

API示例

md toc有一个public API。例如，这意味着你可以很容易地 在另一个python程序中构建toc。最简单的建造方法 对于降价文件是：

>>> import md_toc
>>> f = open('foo.md')
>>> print(f.read(), end='')
# this
## is
## a
### foo
#### booo
### foo
## file

## bye

# bye
>>> print(md_toc.build_toc('foo.md'), end='')
- [this](#this)
  - [is](#is)
  - [a](#a)
    - [foo](#foo)
    - [foo](#foo-1)
  - [file](#file)
  - [bye](#bye)
- [bye](#bye-1)

cli帮助

$ md_toc --help
$ md_toc github --help
$ md_toc redcarpet --help

许可证

版权所有（c）2017-2019 FRNMST（Franco Masotti）<；franco.masotti@live.com>；

md-toc是免费软件：您可以重新分发和/或修改它 根据由 自由软件基金会，或者许可证的第3版，或者 （由您选择）任何更高版本。

md-toc的发布是希望它能有用， 但没有任何保证；甚至没有 适销性或适合某一特定目的的适销性。见 GNU通用公共许可证了解更多详细信息。

你应该收到GNU通用公共许可证的副本 以及MD TOC。如果没有，请参见<；http://www.gnu.org/licenses/>；。