markdown

Documentation

Index

• type Parser
  • func NewParser(options ParserOpts) *Parser
  • func (p *Parser) Parse(source string) (*note.Content, error)
• type ParserOpts

Types

type Parser

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

Parser parses the content of Markdown notes.

func NewParser

func NewParser(options ParserOpts) *Parser

NewParser creates a new Markdown Parser.

func (*Parser) Parse

func (p *Parser) Parse(source string) (*note.Content, error)

Parse implements note.Parse.

type ParserOpts

type ParserOpts struct {
	// Indicates whether #hashtags are parsed.
	HashtagEnabled bool
	// Indicates whether Bear's multi-word tags are parsed. Hashtags must be enabled as well.
	MultiWordTagEnabled bool
	// Indicates whether :colon:tags: are parsed.
	ColontagEnabled bool
}