How krazybee/goldmark works
goldmark is a pure-Go, CommonMark-compliant Markdown parser and HTML renderer. The main workflow is caller input → Markdown conversion orchestration → text reader and parser → AST → renderer → output writer. Parser syntax is organized around block and inline parsing, with extensions adding documented dialect features such as GFM tables and task lists, footnotes, definition lists, linkification, and typography. The graph reflects the sampled orchestration and module references; some extension wiring and parser internals are unsampled, so uncertain links are omitted.
Main entry points: parser.go Parser engine · markdown.go Conversion API · table.go Tables · html.go HTML renderer
Components 18
Conversion Core
- Conversion API
markdown.go - Text reader
text/reader.go
Parsing and AST
- Parser engine
parser/parser.go - Block syntax
parser/paragraph.go - Links and delimiters
parser/link.go - Attributes
parser/attribute.go - Document AST
ast/ast.go
Rendering
- Renderer engine
renderer/renderer.go - HTML renderer
renderer/html/html.go
Markdown Extensions
- GFM features
extension/gfm.go - Tables
extension/table.go - Footnotes
extension/footnote.go - Definition lists
extension/definition_list.go - Linkify
extension/linkify.go - Typography
extension/typographer.go - Other built-ins
extension
Other components
- Markdown caller
- Output writer
Connections 25
- Markdown caller → Conversion API: submits Markdown
- Conversion API → Text reader: creates reader
markdown.go - Conversion API → Parser engine: parses input
markdown.go - Text reader → Parser engine: supplies text
- Parser engine → Document AST: builds AST
parser/parser.go - Parser engine → Block syntax: dispatches parsing
parser/parser.go - Parser engine → Links and delimiters: uses syntax
parser/parser.go - Parser engine → Attributes: uses syntax
parser/parser.go - Conversion API → Renderer engine: renders document
markdown.go - Renderer engine → Document AST: walks nodes
renderer/renderer.go - Renderer engine → HTML renderer: registers renderer
- HTML renderer → Document AST: renders nodes
renderer/html/html.go - Conversion API → Output writer: writes result
markdown.go - Conversion API → GFM features: accepts extension
- GFM features → Tables: enables feature
- GFM features → Other built-ins: enables features
- Tables → Parser engine: adds transformer
extension/table.go - Tables → Document AST: builds table nodes
extension/table.go - Tables → HTML renderer: provides rendering
extension/table.go - Footnotes → Parser engine: adds parsers
extension/footnote.go - Footnotes → HTML renderer: provides rendering
extension/footnote.go - Definition lists → Parser engine: adds parsing
extension/definition_list.go - Linkify → Parser engine: adds parsing
extension/linkify.go - Typography → Parser engine: adds transformer
extension/typographer.go - Other built-ins → Parser engine: adds features