业务需要
在编写 github 项目时,有时候会编写各种 README.md
等 markdown 文件,但是 github 默认是没有目录的。
于是就自己写了一个小工具。
markdown-toc
markdown-toc 可以用来生成 markdown 页面的目录,便于 github 页面展现。
Features
-
Github Markdown 文件一键生成目录
-
支持 fluent 优雅的写法
-
支持多次生成
-
支持重复标题的生成
-
支持特殊字符的过滤
-
支持指定不同的文件编码
-
支持文件夹的文件批量处理(可指定是否包含子文件夹文件)
-
支持是否写入文件,可返回目录的内容,便于用户自行处理
-
...
环境依赖
JDK
JDK7+, 请确保 JDK 设置正确。
Maven
Jar 使用 Maven 进行统一管理。
快速入门
maven 引入
<dependency>
<groupId>com.github.houbb</groupId>
<artifactId>markdown-toc</artifactId>
<version>1.0.2</version>
</dependency>
md 文件
本项目支持的 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 文件对应的目录内容 |
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
· DeepSeek “源神”启动!「GitHub 热点速览」
· 我与微信审核的“相爱相杀”看个人小程序副业
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)
· spring官宣接入deepseek,真的太香了~