Categorygithub.com/apocelipes/autotocpkgparser
package
0.0.0-20240525091807-dcdb3afbcdc7
Repository: https://github.com/apocelipes/autotoc.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
9
Dependents
1
Files
519 SLOC

# Functions

GetInnerParser 获取标题解析器。topTag是可标题的最大级别（例如h1-h5中的h1）.
GetParser 根据name创建markdown文档解析器.
NewTitleNode 创建新节点，tag是html tag名称.
SetInnerParser 注册新的标题解析器.
WithFilter 根据标题内容确定是否需要被解析.
WithScanType 设置需要解析的标题类型（html, markdown）.
TocMark 设置文档中的toc标记.
WithTopTag 设置开始解析的标题层级，值为h1-h5.
WithURLEncoder 设置标题内容的编码器，非ascii字符作为URL时可能需要编码.

# Constants

HTMLTitleParserName name of HTMLTitleParser for the parser factory.
MarkdownTitleParserName name of MarkdownTitleParser for the parser factory.
No description provided by the author

# Structs

No description provided by the author
Parser 进行整个markdown的解析.
TitleNode 标题节点，按顶层标签构建的节点树 节点树的生长方向是单一的固定的， 假设节点按从左向右生长则最新添加的子节点一定在最右或者是最右子节点的后代.

# Interfaces

TitleFilter 根据规则过滤标题.
TitleParser 解析文件中的标题结构.

# Type aliases

ContentEncoder 对URL进行编码的函数，传入URL，传出编码后的结果.
Creator 创建parser的函数类型，接受一个string作为顶层标题结构，被SetParser调用.
No description provided by the author