markdown

Documentation

Index

• type Heading
• type Html
• type MarkdownFile
  • func DirectoryIndex(dirPath string, rootDir string) (MarkdownFile, error)
  • func ForDirectory(dirPath string, rootDir string) (MarkdownFile, error)
  • func FromFile(filePath string) (MarkdownFile, error)
• type Title

Types

type Heading

type Heading interface {
	Level() int
	Text() string
	Id() string
}

type Html

type Html interface {
	ToHtml() string
}

type MarkdownFile

type MarkdownFile interface {
	Title() Title
	Head() []Html
	MainContent() Html
	Headings() []Heading // TODO: use this to generate TOC
}

func DirectoryIndex

func DirectoryIndex(dirPath string, rootDir string) (MarkdownFile, error)

func ForDirectory

func ForDirectory(dirPath string, rootDir string) (MarkdownFile, error)

func FromFile

func FromFile(filePath string) (MarkdownFile, error)

TODO: cache this so we don't keep parsing everything repeatedly

type Title

type Title interface {
	ToHtml() string
	Text() string
}