Package: github.com/gomarkdown/markdown/parser

package parser Import Path github.com/gomarkdown/markdown/parser (on go.dev) Dependency Relation imports 11 packages, and imported by 3 packages

Involved Source Files aside.go attribute.go block.go block_table.go callout.go caption.go citation.go esc.go figures.go include.go inline.go matter.go options.go d parser.go Package parser implements parser for markdown text that generates AST (abstract syntax tree). ref.go

Package-Level Type Names (total 9)

/* sort by: alphabet | popularity */

type BlockFunc (func) BlockFunc allows to registration of a parser function. If successful it returns an ast.Node, a buffer that should be parsed as a block and the the number of bytes consumed.

type Extensions int (basic type) Extensions is a bitmask of enabled parser extensions. As Inputs Of (at least one exported) func NewWithExtensions(extension Extensions) *Parser As Types Of (total 26) const Attributes const AutoHeadingIDs const Autolink const BackslashLineBreak const CommonExtensions const DefinitionLists const EmptyLinesBreakList const FencedCode const Footnotes const HardLineBreak const HeadingIDs const Includes const LaxHTMLBlocks const MathJax const Mmark const NoEmptyLineBeforeBlock const NoExtensions const NoIntraEmphasis const NonBlockingSpace const OrderedListStart const SpaceHeadings const Strikethrough const SuperSubscript const Tables const TabSizeEight const Titleblock

type Flags int (basic type) Flags control optional behavior of parser. As Types Of (total 2) const FlagsNone const SkipFootnoteList

type InlineParser (func) for each character that triggers a response when parsing inline data. As Outputs Of (at least one exported) func (*Parser).RegisterInline(n byte, fn InlineParser) InlineParser As Inputs Of (at least one exported) func (*Parser).RegisterInline(n byte, fn InlineParser) InlineParser

type Options (struct) Options is a collection of supplementary parameters tweaking the behavior of various parts of the parser. Fields (total 3) Flags Flags // Flags allow customizing parser's behavior ParserHook BlockFunc ReadIncludeFn ReadIncludeFunc

type Parser (struct) Parser is a type that holds extensions and the runtime state used by Parse, and the renderer. You can not use it directly, construct it with New. Fields (total 5) Doc ast.Node after parsing, this is AST root of parsed markdown text InsideLink bool IsSafeURLOverride func(url []byte) bool IsSafeURLOverride allows overriding the default URL matcher. URL is safe if the overriding function returns true. Can be used to extend the default list of safe URLs. Opts Options ReferenceOverride ReferenceOverrideFunc ReferenceOverride is an optional function callback that is called every time a reference is resolved. It can be set before starting parsing. In Markdown, the link reference syntax can be made to resolve a link to a reference instead of an inline URL, in one of the following ways: * [link text][refid] * [refid][] Usually, the refid is defined at the bottom of the Markdown document. If this override function is provided, the refid is passed to the override function first, before consulting the defined refids at the bottom. If the override function indicates an override did not occur, the refids at the bottom will be used to fill in the link details. Methods (total 6) (*Parser) AddBlock(n ast.Node) ast.Node (*Parser) Block(data []byte) Parse Block-level data. Note: this function and many that it calls assume that the input buffer ends with a newline. (*Parser) Finalize(block ast.Node) (*Parser) Inline(currBlock ast.Node, data []byte) Inline parses text within a block. Each function returns the number of consumed chars. (*Parser) Parse(input []byte) ast.Node Parse generates AST (abstract syntax tree) representing markdown document. The result is a root of the tree whose underlying type is *ast.Document You can then convert AST to html using html.Renderer, to some other format using a custom renderer or transform the tree. Parser is not reusable. Create a new Parser for each Parse() call. (*Parser) RegisterInline(n byte, fn InlineParser) InlineParser As Outputs Of (at least 2) func New() *Parser func NewWithExtensions(extension Extensions) *Parser As Inputs Of (at least 2) func github.com/gomarkdown/markdown.Parse(markdown []byte, p *Parser) ast.Node func github.com/gomarkdown/markdown.ToHTML(markdown []byte, p *Parser, renderer markdown.Renderer) []byte

type ReadIncludeFunc (func) ReadIncludeFunc should read the file under path and returns the read bytes, from will be set to the name of the current file being parsed. Initially this will be empty. address is the optional address specifier of which lines of the file to return. If this function is not set no data will be read.

type Reference (struct) Reference represents the details of a link. See the documentation in Options for more details on use-case. Fields (total 3) Link string Link is usually the URL the reference points to. Text string Text is the optional text to override the ref with if the syntax used was [refid][] Title string Title is the alternate text describing the link in more detail.

type ReferenceOverrideFunc (func) ReferenceOverrideFunc is expected to be called with a reference string and return either a valid Reference type that the reference string maps to or nil. If overridden is false, the default reference logic will be executed. See the documentation in Options for more details on use-case.

Package-Level Functions (total 12)

func IsAlnum(c byte) bool IsAlnum returns true if c is a digit or letter TODO: check when this is looking for ASCII alnum and when it should use unicode

func IsCallout(data []byte) (id []byte, consumed int) IsCallout detects a callout in the following format: <<N>> Where N is a integer > 0.

func IsEmpty(data []byte) int

func IsLetter(c byte) bool IsLetter returns true if c is ascii letter

func IsPunctuation(c byte) bool IsPunctuation returns true if c is a punctuation symbol.

func IsPunctuation2(d []byte) bool

func IsSafeURL(url []byte) bool IsSafeURL returns true if url starts with one of the valid schemes or is a relative path.

func IsSpace(c byte) bool IsSpace returns true if c is a white-space character

func LinesUntilEmpty(data []byte) int LinesUntilEmpty scans lines up to the first empty line.

func New() *Parser New creates a markdown parser with CommonExtensions. You can then call `doc := p.Parse(markdown)` to parse markdown document and `markdown.Render(doc, renderer)` to convert it to another format with a renderer.

func NewWithExtensions(extension Extensions) *Parser NewWithExtensions creates a markdown parser with given extensions.

func NormalizeNewlines(d []byte) []byte

Package-Level Variables (total 3)

var EscapeChars []byte '\\' backslash escape

var Paths [][]byte

var URIs [][]byte

Package-Level Constants (total 28)

const Attributes Extensions = 1048576 // Block Attributes Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const AutoHeadingIDs Extensions = 32768 // Create the heading ID from the text Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const Autolink Extensions = 16 // Detect embedded URLs that are not explicitly marked Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const BackslashLineBreak Extensions = 65536 // Translate trailing backslashes into line breaks Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const CommonExtensions Extensions = 467134 Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const DefinitionLists Extensions = 131072 // Parse definition lists Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const EmptyLinesBreakList Extensions = 4194304 // 2 empty lines break out of list Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const FencedCode Extensions = 8 // Parse fenced code blocks Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const FlagsNone Flags = 0 Parser renderer configuration options.

const Footnotes Extensions = 2048 // Pandoc-style footnotes Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const HardLineBreak Extensions = 256 // Translate newlines into line breaks Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const HeadingIDs Extensions = 8192 // specify heading IDs with {#id} Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const Includes Extensions = 8388608 // Support including other files. Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const LaxHTMLBlocks Extensions = 64 // Loosen up HTML block parsing rules Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const MathJax Extensions = 262144 // Parse MathJax Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const Mmark Extensions = 16777216 // Support Mmark syntax, see https://mmark.miek.nl/post/syntax/ Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const NoEmptyLineBeforeBlock Extensions = 4096 // No need to insert an empty line to start a (code, quote, ordered list, unordered list) block Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const NoExtensions Extensions = 0 Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const NoIntraEmphasis Extensions = 2 // Ignore emphasis markers inside words Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const NonBlockingSpace Extensions = 512 // Translate backspace spaces into line non-blocking spaces Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const OrderedListStart Extensions = 524288 // Keep track of the first number used when starting an ordered list. Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const SkipFootnoteList Flags = 2 // Skip adding the footnote list (regardless if they are parsed) Parser renderer configuration options.

const SpaceHeadings Extensions = 128 // Be strict about prefix heading rules Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const Strikethrough Extensions = 32 // Strikethrough text using ~~test~~ Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const SuperSubscript Extensions = 2097152 // Super- and subscript support: 2^10^, H~2~O. Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const Tables Extensions = 4 // Parse tables Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const TabSizeEight Extensions = 1024 // Expand tabs to eight spaces instead of four Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.

const Titleblock Extensions = 16384 // Titleblock ala pandoc Bit flags representing markdown parsing extensions. Use | (or) to specify multiple extensions.