Markdown解析器Go语言实现的技术文档

1. 安装指南

要安装本项目，您需要具备Go 1版本的环境以及git工具。以下是安装步骤：

go get github.com/knieriem/markdown

该命令将根据您的GOPATH设置下载并安装包。

2. 项目的使用说明

本项目是一个用Go语言编写的Markdown解析器，它是John Gruber的Markdown的Go语言实现，基于John MacFarlane的peg-markdown C语言版本。项目使用了Andrew J Snodgrass的PEG解析器的一个修改版本来支持LEG语法。

本项目支持HTML和groff mm输出，但LaTeX输出尚未移植。输出结果与peg-markdown相同。

3. 项目API使用文档

本项目的详细API文档尚未提供。不过，您可以在doc.go文件中找到一个使用该包的示例。

4. 项目安装方式

4.1 创建命令行程序

要创建命令行程序markdown，请运行以下命令：

go build github.com/knieriem/markdown/cmd/markdown

执行后，二进制文件应可在当前目录下找到。

4.2 运行测试

运行以下命令来执行测试：

go test github.com/knieriem/markdown

当前测试基于John Gruber的Markdown 1.0.3测试套件，并比较转换后.text文件到HTML的输出来验证正确性。

4.3 开发环境配置

在构建包和命令时，Go工具尚不能自动从另一个文件生成类似parser.leg.go的Go源文件。为了使markdown能够通过go get安装，parser.leg.go文件已被添加到版本控制系统中。

当parser.leg文件被修改或parser.leg.go文件缺失时，运行Make parser命令将使用leg工具更新parser.leg.go文件。如果系统中还没有安装peg，可以运行以下命令安装：

go get github.com/knieriem/peg

之后，make parser命令应该可以成功执行。

以上就是关于本Markdown解析器Go语言实现的项目技术文档，希望对您的使用有所帮助。