Categorygithub.com/iris-contrib/blackfriday
modulepackage
2.0.0+incompatible
Repository: https://github.com/iris-contrib/blackfriday.git
Documentation: pkg.go.dev

# Functions

New constructs a Markdown processor.
NewHTMLRenderer creates and configures an HTMLRenderer object, which satisfies the Renderer interface.
NewNode allocates a node of a specified type.
NewSmartypantsRenderer constructs a Smartypants renderer object.
Run is the main entry point to Blackfriday.
WithExtensions allows you to pick some of the many extensions provided by Blackfriday.
WithNoExtensions turns off all extensions and custom behavior.
WithRefOverride sets an optional function callback that is called every time a reference is resolved.
WithRenderer allows you to override the default renderer.

# Constants

Create the heading ID from the text.
Detect embedded URLs that are not explicitly marked.
Translate trailing backslashes into line breaks.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
These are the supported markdown parsing extensions.
These are the supported markdown parsing extensions.
Generate a complete HTML page.
Render definition lists.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Render fenced code blocks.
Generate a link at the end of a footnote to return to the source.
Pandoc-style footnotes.
GoToNext is the default traversal of every node.
Constants for identifying different types of nodes.
Translate newlines into line breaks.
Constants for identifying different types of nodes.
specify heading IDs with {#id}.
Constants for identifying different types of nodes.
Add a blank target.
Constants for identifying different types of nodes.
HTML renderer configuration options.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Loosen up HTML block parsing rules.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
TODO: figure out if this is of any use now.
These are the possible flag values for the ListItem renderer.
These are the possible flag values for the ListItem renderer.
These are the possible flag values for the ListItem renderer.
These are the possible flag values for the ListItem renderer.
These are the possible flag values for the ListItem renderer.
No need to insert an empty line to start a (code, quote, ordered list, unordered list) block.
These are the supported markdown parsing extensions.
Only link with rel="nofollow".
Ignore emphasis markers inside words.
Only link with rel="noopener".
Only link with rel="noreferrer".
Constants for identifying different types of nodes.
Only link to trusted protocols.
SkipChildren tells walker to skip all children of current node.
Skip preformatted HTML blocks.
Skip embedded images.
Skip all links.
Enable smart punctuation substitutions.
Enable angled double quotes (with Smartypants) for double quotes rendering.
Enable smart dashes (with Smartypants).
Enable smart fractions (with Smartypants).
Enable LaTeX-style dashes (with Smartypants).
Enable « French guillemets » (with Smartypants).
Constants for identifying different types of nodes.
Be strict about prefix heading rules.
Strikethrough text using ~~test~~.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
These are the possible flag values for the table cell renderer.
These are the possible flag values for the table cell renderer.
These are the possible flag values for the table cell renderer.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Constants for identifying different types of nodes.
Render tables.
The size of a tab stop.
The size of a tab stop.
Expand tabs to eight spaces instead of four.
Terminate tells walker to terminate the traversal.
Constants for identifying different types of nodes.
Titleblock ala pandoc.
Generate a table of contents.
Generate XHTML output instead of HTML.
Version string of the package.

# Structs

CodeBlockData contains fields relevant to a CodeBlock node type.
HeadingData contains fields relevant to a Heading node type.
HTMLRenderer is a type that implements the Renderer interface for HTML output.
HTMLRendererParameters is a collection of supplementary parameters tweaking the behavior of various parts of HTML renderer.
LinkData contains fields relevant to a Link node type.
ListData contains fields relevant to a List and Item node type.
Markdown is a type that holds extensions and the runtime state used by Parse, and the renderer.
Node is a single element in the abstract syntax tree of the parsed document.
Reference represents the details of a link.
SPRenderer is a struct containing state of a Smartypants renderer.
TableCellData contains fields relevant to a TableCell node type.

# Interfaces

Renderer is the rendering interface.

# Type aliases

CellAlignFlags holds a type of alignment in a table cell.
Extensions is a bitwise or'ed collection of enabled Blackfriday's extensions.
HTMLFlags control optional behavior of HTML renderer.
ListType contains bitwise or'ed flags for list and list item objects.
NodeType specifies a type of a single node of a syntax tree.
NodeVisitor is a callback to be called when traversing the syntax tree.
Option customizes the Markdown processor's default behavior.
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.
WalkStatus allows NodeVisitor to have some control over the tree traversal.