gomarkdown/markdown 项目教程

1. 项目目录结构及介绍

gomarkdown/markdown
├── .github
│   └── workflows
├── cmd
│   └── printast
├── examples
├── html
├── md
├── parser
├── ss
├── testdata
├── .gitignore
├── LICENSE.txt
├── README.md
├── block_test.go
├── changes-from-blackfriday.md
├── doc.go
├── esc_test.go
├── fuzz
│   └── fuzz_crashes_test.go
├── go.mod
├── go.sum
├── helpers_test.go
├── html_renderer_test.go
├── inline_test.go
├── markdown.go
├── markdown_test.go
├── md_test.go
├── mmark_test.go
├── ref_test.go
└── README.md

目录结构介绍

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• cmd/printast: 包含用于打印抽象语法树（AST）的命令行工具。
• examples: 包含使用该库的示例代码。
• html: 包含HTML渲染器的相关代码。
• md: 包含Markdown解析器的相关代码。
• parser: 包含Markdown解析器的核心代码。
• ss: 包含一些辅助代码。
• testdata: 包含测试数据。
• .gitignore: Git忽略文件配置。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• block_test.go: 块级元素测试代码。
• changes-from-blackfriday.md: 与Blackfriday项目的差异说明。
• doc.go: 项目文档。
• esc_test.go: 转义测试代码。
• fuzz: 包含模糊测试的相关代码。
• go.mod: Go模块依赖管理文件。
• go.sum: Go模块依赖校验文件。
• helpers_test.go: 辅助函数测试代码。
• html_renderer_test.go: HTML渲染器测试代码。
• inline_test.go: 行内元素测试代码。
• markdown.go: Markdown解析器的主文件。
• markdown_test.go: Markdown解析器测试代码。
• md_test.go: Markdown测试代码。
• mmark_test.go: Mmark测试代码。
• ref_test.go: 引用测试代码。

2. 项目启动文件介绍

项目的启动文件主要是cmd/printast目录下的文件，用于启动命令行工具来打印Markdown文档的抽象语法树（AST）。

启动文件介绍

• cmd/printast/main.go: 主程序文件，负责解析命令行参数并调用Markdown解析器生成AST，然后将其打印出来。

3. 项目配置文件介绍

项目的主要配置文件是go.mod和go.sum，用于管理Go模块的依赖关系和版本校验。

配置文件介绍

• go.mod: 定义了项目的模块路径和依赖的模块及其版本。
• go.sum: 记录了每个依赖模块的哈希值，用于校验依赖的完整性和安全性。

通过这些配置文件，开发者可以轻松管理项目的依赖关系，确保项目的稳定性和安全性。