How yuin/goldmark works
goldmark is a Go Markdown processing library: callers provide Markdown, the parser builds a source-aware AST, and a separate renderer produces HTML (or another format). Its AST also supports programmatic construction and semantic analysis. Built-in and custom extensions add syntax and rendering, including GFM-style tables, task lists, footnotes, and typographic transformations. The README documents the main parse/render workflow; some internal connections and unsampled extension implementations are therefore shown only where documented or excerpted.
Main entry points: parser.go Markdown parser · table.go Table extension · ast.go AST node model · renderer.go Renderer framework
Components 22
Parsing
- Markdown parser
parser/parser.go - Paragraph parser
parser/paragraph.go - Link and delimiter parsing
parser/link.go - HTML block parsing
parser/html_block.go
AST and source
- AST node model
ast/ast.go - Block nodes
ast/block.go - Inline nodes
ast/inline.go - Source values
text/value.go - Text reader
text/reader.go - Text decoder
text/decoder.go
Rendering
- Renderer framework
renderer/renderer.go - HTML renderer
renderer/html/html.go
Extensions
- Table extension
extension/table.go - Table AST nodes
extension/ast/table.go - Footnote extension
extension/footnote.go - Definition lists
extension/definition_list.go - Typographer
extension/typographer.go - GFM bundle
extension/gfm.go - Strikethrough
extension/strikethrough.go - Task lists
extension/tasklist.go - Linkify
extension/linkify.go
Other components
- Application
Connections 22
- Application → Markdown parser: parses Markdown
README.md - Markdown parser → AST node model: builds AST
README.md - Markdown parser → Text reader: reads source
- Paragraph parser → Block nodes: creates paragraphs
parser/paragraph.go - Link and delimiter parsing → Inline nodes: parses inline nodes
- HTML block parsing → Block nodes: creates HTML blocks
- AST node model → Source values: retains source values
ast/ast.go - Source values → Text decoder: decodes values
text/value.go - Application → Renderer framework: renders AST
README.md - Renderer framework → AST node model: walks AST
renderer/renderer.go - HTML renderer → Renderer framework: configures rendering
renderer/html/html.go - Application → HTML renderer: selects HTML output
README.md - Table extension → Table AST nodes: creates table nodes
extension/table.go - Table extension → Block nodes: transforms paragraphs
extension/table.go - Application → Table extension: enables extensions
README.md - Application → Footnote extension: enables extensions
README.md - Application → Definition lists: enables extensions
README.md - Application → Typographer: enables extensions
README.md - Application → GFM bundle: enables extensions
README.md - Application → Strikethrough: enables extensions
README.md - Application → Task lists: enables extensions
README.md - Application → Linkify: enables extensions