markdown

Documentation

Index

• Variables
• func ExtractAnnotatedBlock(annotation string, s string) (string, error)
• func SplitLines(s string) []string
• func ToListItem(lines string) []string
• type Markdown
  • func Parse(content string) *Markdown
  • func (m *Markdown) AppendSection(s *MarkdownSection)
  • func (m *Markdown) FindSectionByHeading(level int, headline string) *MarkdownSection
  • func (m *Markdown) FindSectionByHeadingPrefix(level int, headlinePrefix string) *MarkdownSection
  • func (m *Markdown) PrependSection(s *MarkdownSection)
  • func (m *Markdown) String() string
• type MarkdownSection
  • func (m *MarkdownSection) AppendChild(child *MarkdownSection)
  • func (m *MarkdownSection) AppendContent(contentLines []string)
  • func (m *MarkdownSection) FindSectionByHeading(level int, headline string) *MarkdownSection
  • func (m *MarkdownSection) PrependChild(child *MarkdownSection)
  • func (m *MarkdownSection) PrependContent(contentLines []string)
  • func (m *MarkdownSection) String() string

Variables

var NoSuchBlockError = fmt.Errorf("no such block")

Functions

func ExtractAnnotatedBlock

func ExtractAnnotatedBlock(annotation string, s string) (string, error)

func SplitLines

func SplitLines(s string) []string

func ToListItem

func ToListItem(lines string) []string

Types

type Markdown

type Markdown struct {
	// contains filtered or unexported fields
}

func Parse

func Parse(content string) *Markdown

func (*Markdown) AppendSection

func (m *Markdown) AppendSection(s *MarkdownSection)

func (*Markdown) FindSectionByHeading

func (m *Markdown) FindSectionByHeading(level int, headline string) *MarkdownSection

func (*Markdown) FindSectionByHeadingPrefix

func (m *Markdown) FindSectionByHeadingPrefix(level int, headlinePrefix string) *MarkdownSection

func (*Markdown) PrependSection

func (m *Markdown) PrependSection(s *MarkdownSection)

func (*Markdown) String

func (m *Markdown) String() string

type MarkdownSection

type MarkdownSection struct {
	Level        int
	Heading      string
	ContentLines []string
	SubSections  []*MarkdownSection
}

func (*MarkdownSection) AppendChild

func (m *MarkdownSection) AppendChild(child *MarkdownSection)

func (*MarkdownSection) AppendContent

func (m *MarkdownSection) AppendContent(contentLines []string)

func (*MarkdownSection) FindSectionByHeading

func (m *MarkdownSection) FindSectionByHeading(level int, headline string) *MarkdownSection

func (*MarkdownSection) PrependChild

func (m *MarkdownSection) PrependChild(child *MarkdownSection)

func (*MarkdownSection) PrependContent

func (m *MarkdownSection) PrependContent(contentLines []string)

func (*MarkdownSection) String

func (m *MarkdownSection) String() string