com.github.houbb.markdown.toc.core

接口 MarkdownToc

所有已知实现类:

AtxMarkdownToc

@API(status=MAINTAINED,
     since="1.0.0")
public interface MarkdownToc

markdown toc

从以下版本开始:

1.0.0, 2018/01/30

版本:

1.0.0

作者:

bbhou

方法概要

限定符和类型	方法和说明
List<TocGen>	genTocDir(String dirPath) 生成指定目录下的所有 markdown 文件 toc
TocGen	genTocFile(String filePath) 生成单个文件的 toc

方法详细资料

genTocFile

TocGen genTocFile(String filePath)

生成单个文件的 toc

参数:

filePath - 文件路径

返回:

生成的结果信息

genTocDir

List<TocGen> genTocDir(String dirPath)

生成指定目录下的所有 markdown 文件 toc

参数:

dirPath - 文件夹路径

返回:

生成的结果信息列表