mdtoc

Documentation

Index

• Constants
• func GenerateTOC(doc []byte, opts Options) (string, error)
• func GetTOC(file string, opts Options) (string, error)
• func WriteTOC(file string, opts Options) error
• type Options

Constants

const (
	// StartTOC is the opening tag for the table of contents.
	StartTOC = "<!-- toc -->"
	// EndTOC is the tag that marks the end of the TOC.
	EndTOC = "<!-- /toc -->"
	// MaxHeaderDepth is the default maximum header depth for ToC generation.
	MaxHeaderDepth = 6
)

Functions

func GenerateTOC

func GenerateTOC(doc []byte, opts Options) (string, error)

GenerateTOC parses a document and returns its TOC.

func GetTOC

func GetTOC(file string, opts Options) (string, error)

GetTOC generates the TOC from a file with options. Returns the generated toc, and any error.

func WriteTOC

func WriteTOC(file string, opts Options) error

WriteTOC writes the TOC generator on file with options. Returns the generated toc, and any error.

Types

type Options

type Options struct {
	Dryrun     bool
	SkipPrefix bool
	Version    bool
	MaxDepth   int
}

Options set for the toc generator.