Skip to content
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

This is an implementation of John Gruber's markdown in Go. It is a translation of peg-markdown, written by John MacFarlane in C, into Go. It is using a modified version of Andrew J Snodgrass' PEG parser peg -- now supporting LEG grammars --, which itself is based on the parser used by peg-markdown.

Support for HTML and groff mm output is implemented, but LaTeX output has not been ported. The output is identical to that of peg-markdown.

I try to keep the grammar in sync with the C version, by cherry-picking relevant changes. In the commit history the corresponding revisions have a suffix [jgm/peg-markdown].

The Markdown parser has a performance similar to that of the original C version, and consumes less memory.


Provided you have a copy of Go 1, and git is available,

go get

should download and install the package according to your GOPATH settings.

See doc.go for an example how to use the package.

To create the command line program markdown, run

go build

the binary should then be available in the current directory.

To run tests, type

go test

At the moment, tests are based on the .text files from the Markdown 1.0.3 test suite created by John Gruber, imported from peg-markdown. The output of the conversion of these .text files to html is compared to the output of peg-markdown.


There is not yet a way to create a Go source file like parser.leg.go automatically from another file, parser.leg, when building packages and commands using the Go tool. To make markdown installable using go get, parser.leg.go has been added to the VCS.

Make parser will update parser.leg.go using leg – which is part of knieriem/peg at github –, if parser.leg has been changed, or if the Go file is missing. If a copy of peg is not yet present on your system, run

go get

Then make parser should succeed.


In addition to the extensions already present in peg-markdown, this package also supports definition lists (option -dlists) similar to the way they are described in the documentation of PHP Markdown Extra.

Definitions (<dd>...</dd>) are implemented using ListTight and ListLoose, on which bullet lists and ordered lists are based already. If there is an empty line between the definition title and the first definition, a loose list is expected, a tight list otherwise.

As definition item markers both : and ~ can be used.


Subdirectory Index

  • cmd/markdown – command line program markdown


A translation of peg-markdown (an implementation of Markdown in C, using a PEG grammar) into Go



You can’t perform that action at this time.