Registry / utility / mdtoc

mdtoc

JSON →

library1.4.0gogounverified

A tool for generating table of contents in Markdown files.

utility

go get sigs.k8s.io/mdtoc

github ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · MDTOC

mdtoc

utilitygov1.4.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

mdtoc

✓ sigs.k8s.io/mdtoc

Generates a table of contents from a Markdown file's headings.

package main import ( "fmt" "os" "sigs.k8s.io/mdtoc" ) func main() { // Generate TOC for a markdown file input, _ := os.ReadFile("README.md") output, err := mdtoc.Generate(string(input)) if err != nil { fmt.Println("Error:", err) return } fmt.Println(output) }

Debug

Known issues

No known issues recorded.

Upgrade

Version history

1.4.0latest on pkg.go.dev

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/kubernetes-sigs/mdtoc ↗

homepagehttps://github.com/kubernetes-sigs/mdtoc ↗

docshttps://pkg.go.dev/sigs.k8s.io/mdtoc#section-documentation ↗