markdown

Documentation

Index

• type Parser
  • func NewParser(options ParserOpts, logger util.Logger) *Parser
  • func (p *Parser) ParseNoteContent(content string) (*core.NoteContent, 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, logger util.Logger) *Parser

NewParser creates a new Markdown Parser.

func (*Parser) ParseNoteContent

func (p *Parser) ParseNoteContent(content string) (*core.NoteContent, error)

ParseNoteContent implements core.NoteContentParser.

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
}