Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

render

package

Go to main page

Versions in this module

v1

v1.1.2

Jul 9, 2026

v1.1.1

Jul 9, 2026

v1.1.0

Jul 9, 2026

v1.0.1

Jul 7, 2026

v1.0.1-rc.2

Jul 7, 2026

v1.0.0

Jul 5, 2026

Changes in this version

+ func RelTo(fromURL, toURL string) string

+ func StylesCSS(theme string) (string, error)

+ type CodeOptions struct

+ LineNumbers bool

+ Theme string

+ type CodeResult struct

+ HTML template.HTML

+ Lang string

+ Lines int

+ func Code(src []byte, filename string, opts CodeOptions) (CodeResult, error)

+ type Kind int

+ const KindBinary

+ const KindCode

+ const KindHTML

+ const KindImage

+ const KindMarkdown

+ func Classify(path string, size int64, sniff []byte, maxFileSize int64) Kind

+ type Markdown struct

+ func NewMarkdown() *Markdown

+ func (m *Markdown) Render(src []byte, ref PageRef, opts MarkdownOptions) (MarkdownResult, error)

+ type MarkdownOptions struct

+ Anchors bool

+ FrontmatterTitle bool

+ Mermaid bool

+ TOC bool

+ TOCMinHeadings int

+ type MarkdownResult struct

+ HTML template.HTML

+ HasMermaid bool

+ Meta map[string]any

+ TOC []TOCItem

+ Title string

+ type PageRef struct

+ Path string

+ Resolve func(target string) string

+ type TOCItem struct

+ Anchor string

+ Children []TOCItem

+ Level int

+ Title string