markdown

Documentation

Index

• Variables
• func Build(cfg config.ConfigContentMarkdown, options Options) gm.Markdown
• type Document
  • func Render(md gm.Markdown, sourcePath, rawBody string) (Document, error)
• type Options
• type TargetResolver
• type ToCEntry

Variables

var ErrTargetResolverRequired = errors.New("target resolver required")

Functions

func Build

func Build(cfg config.ConfigContentMarkdown, options Options) gm.Markdown

Types

type Document

type Document struct {
	Body     template.HTML
	Sections []template.HTML
	ToC      []ToCEntry
}

func Render

func Render(md gm.Markdown, sourcePath, rawBody string) (Document, error)

type Options

type Options struct {
	TargetResolver TargetResolver
}

type TargetResolver

type TargetResolver func(target string) (string, error)

type ToCEntry

type ToCEntry struct {
	Level int
	ID    string
	Text  string
}