package
0.0.0-20250207164621-7a1f277a159e
Repository: https://github.com/gomarkdown/markdown.git
Documentation: pkg.go.dev

# Functions

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.
IsCallout detects a callout in the following format: <<N>> Where N is a integer > 0.
IsLetter returns true if c is ascii letter.
IsPunctuation returns true if c is a punctuation symbol.
IsSafeURL returns true if url starts with one of the valid schemes or is a relative path.
IsSpace returns true if c is a white-space character.
LinesUntilEmpty scans lines up to the first empty line.
New creates a markdown parser with CommonExtensions.
NewWithExtensions creates a markdown parser with given extensions.

# Constants

Block Attributes.
Create the heading ID from the text.
Detect embedded URLs that are not explicitly marked.
Translate trailing backslashes into line breaks.
Bit flags representing markdown parsing extensions.
Parse definition lists.
2 empty lines break out of list.
Parse fenced code blocks.
Parser renderer configuration options.
Pandoc-style footnotes.
Translate newlines into line breaks.
specify heading IDs with {#id}.
Support including other files.
Loosen up HTML block parsing rules.
Parse MathJax.
Support Mmark syntax, see https://mmark.miek.nl/post/syntax/.
No need to insert an empty line to start a (code, quote, ordered list, unordered list) block.
Bit flags representing markdown parsing extensions.
Ignore emphasis markers inside words.
Translate backspace spaces into line non-blocking spaces.
Keep track of the first number used when starting an ordered list.
Skip adding the footnote list (regardless if they are parsed).
Be strict about prefix heading rules.
Strikethrough text using ~~test~~.
Super- and subscript support: 2^10^, H~2~O.
Parse tables.
Expand tabs to eight spaces instead of four.
Titleblock ala pandoc.

# Variables

'\\' backslash escape.

# Structs

Options is a collection of supplementary parameters tweaking the behavior of various parts of the parser.
Parser is a type that holds extensions and the runtime state used by Parse, and the renderer.
Reference represents the details of a link.

# Type aliases

BlockFunc allows to registration of a parser function.
Extensions is a bitmask of enabled parser extensions.
Flags control optional behavior of parser.
for each character that triggers a response when parsing inline data.
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.
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.