_ __ ___ __ _ _ __| | ____| | _____ ___ __ | |_ ___ ___
| '_ ` _ \ / _` | '__| |/ / _` |/ _ \ \ /\ / / '_ \ _____| __/ _ \ / __|
| | | | | | (_| | | | < (_| | (_) \ V V /| | | |_____| || (_) | (__
|_| |_| |_|\__,_|_| |_|\_\__,_|\___/ \_/\_/ |_| |_| \__\___/ \___|
Markdown-toc 可以用来生成 markdown 页面的目录，便于 github 页面展现。
- 文档
备注
对于标题，md 有两种语法 setext 和 atx 模式。
暂时只支持 atx 形式。
-
Github Markdown 文件一键生成目录
-
支持 fluent 优雅的写法
-
支持多次生成
-
支持重复标题的生成
-
支持特殊字符的过滤
-
支持指定不同的文件编码
-
支持文件夹的文件批量处理(可指定是否包含子文件夹文件)
-
支持是否写入文件，可返回目录的内容，便于用户自行处理
-
支持多线程写文件
-
支持 i18n
JDK7+, 请确保 JDK 设置正确。
Jar 使用 Maven 进行统一管理。
<dependency>
<groupId>com.github.houbb</groupId>
<artifactId>markdown-toc</artifactId>
<version>${maven-version}</version>
</dependency>本项目支持的 md 文件后缀名称为 .md 或者 .markdown
- 单个文件
AtxMarkdownToc.newInstance().genTocFile(path);其中 path 为 md 文件的路径
- 指定文件夹
AtxMarkdownToc.newInstance().genTocFile(path);其中 path 为 md 文件的父类文件夹
- 代码示例
AtxMarkdownToc.newInstance()
.charset("UTF-8")
.write(true)
.subTree(true);| 序号 | 属性 | 默认值 | 说明 |
|---|---|---|---|
| 1 | charset | UTF-8 |
文件编码 |
| 2 | write | true |
是否将 toc 写入文件(默认写入) |
| 3 | subTree | true |
是否包含子文件夹的文件(默认包含) |
genTocFile() 返回 TocGen，genTocDir() 返回 List
- TocGen 属性说明
| 序号 | 属性 | 类型 | 说明 |
|---|---|---|---|
| 1 | filePath | String | 当前 md 的文件路径 |
| 2 | tocLines | List | 当前 md 文件对应的目录内容 |