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

md2html

package module

Go to main page

Versions in this module

v0

v0.8.0

Sep 25, 2026

Changes in this version

+ const SourceID

type Options

+ NoSource bool

v0.7.0

Sep 25, 2026

Changes in this version

+ func IsTOCMode(s string) bool

type Options

+ TOC string

v0.6.0

Sep 25, 2026

Changes in this version

+ func IsLangTag(s string) bool

type Options

+ Lang string

type Transform

+ func LinkAttrs(warn func(string)) Transform

v0.5.0

Sep 24, 2026

v0.4.0

Sep 15, 2026

v0.3.0

Sep 14, 2026

Changes in this version

+ func InstallSkill(parent string) ([]string, error)

type Transform

+ func Alerts() Transform

v0.2.0

Sep 13, 2026

Changes in this version

+ const MarkerPrefix

+ const Version

+ func Convert(src []byte, opt Options) ([]byte, error)

+ func IsMarkdownPath(p string) bool

+ func IsOurs(path string) (bool, error)

+ func Marker() string

+ type CrawlOptions struct

+ Depth int

+ Entries []string

+ Exclude []string

+ LinkDepth int

+ NoAssets bool

+ NoMdLinks bool

+ OutDir string

+ type CrawlResult struct

+ Base string

+ Docs []Doc

+ External []string

+ Warnings []Warning

+ func Crawl(opt CrawlOptions) (*CrawlResult, error)

+ type Doc struct

+ LinkMap map[string]string

+ Out string

+ Src string

+ type Link struct

+ Abs string

+ Attr string

+ Href string

+ Kind LinkKind

+ Node *html.Node

+ func ExtractLinks(root *html.Node, srcDir string) []Link

+ type LinkKind int

+ const LinkAsset

+ const LinkDoc

+ const LinkFragment

+ const LinkRemote

+ type Options struct

+ CSS string

+ Fragment bool

+ LinkMap map[string]string

+ MermaidURL string

+ SourcePath string

+ Title string

+ Transforms []Transform

+ Warn func(string)

+ type Transform struct

+ Fn func(*html.Node) error

+ Name string

+ func Builtins() []Transform

+ func Chips() Transform

+ func Containers(warn func(string)) Transform

+ func ExternalLinks() Transform

+ func HeadingAnchors() Transform

+ func LinkRewrite(m map[string]string) Transform

+ func SectionLinks() Transform

+ func TOC() Transform

+ func TableScroll() Transform

+ type Warning struct

+ Message string

+ Src string

+ type WriteResult int

+ const WriteCreated

+ const WriteOverwritten

+ const WriteRefused

+ func SafeWrite(path string, data []byte) (WriteResult, error)

+ func (r WriteResult) String() string