github markdown toc 文件目录

很多时候，我们在编写README.md文件的时候想插入目录，但是github对目录支持的并不好，有很多人写了一些工具方便我们使用，记录如下：

第1步：

修改pom文件，引入jar包

<dependency>
  <groupId>com.github.houbb</groupId>
  <artifactId>markdown-toc</artifactId>
  <version>1.0.5</version>
</dependency>

作者的github地址是：https://github.com/houbb/markdown-toc

第2步：

在作者的主页上有演示代码，将代码拷贝到自己的java项目当中

因为我只有一个md文件，所以我拿了单个文件演示代码，也就是AtxMarkdownTocFileTest类。但是这里面有一点小问题，作者并没有提交TestPathUtil类，我自己创建了一个，内容如下：

package com.demo.io;

public class TestPathUtil {
    public static String getAppRootPath(String fileName) {
        return System.getProperty("user.dir")+"/" + fileName;
    }
}

完成以上工作之后，运行的AtxMarkdownTocFileTest类的commonInterfaceTest方法

  /**
     * 普通-新建接口的方式
     */
    @Test
    public void commonInterfaceTest() {
        String path = TestPathUtil.getAppRootPath("README.md");

        MarkdownToc markdownToc = new AtxMarkdownToc();
        TocGen tocGen = markdownToc.genTocFile(path);
        System.out.println(tocGen);
    }

README.md要根据自己的项目情况修改，运行完之后我们打开REAMD.md文件，发现文件被修改了，也就是多了我们想要的目录，大功告成。（亲测有效）

来源：CSDN

作者：wanglf1207

链接：https://blog.csdn.net/wanglf1207/article/details/104110376

标签

文件目录

Markdown

string

toc