Meziantou.Framework.Markdown namespace

Classes

NameDescription
MarkdownAbbreviationDefinitionSyntaxThe definition of an abbreviation: *[HTML]: Hypertext Markup Language.
MarkdownAbbreviationSyntaxAn abbreviation in the text, which a definition of the document gives the meaning of.
MarkdownAlertSyntaxAn alert of GitHub: a block quote whose first line is a kind, such as [!NOTE].
MarkdownAutolinkOptionsHow MarkdownExtensions.MarkdigAutolinks reads the URLs of the text, as the options of the autolinks of Markdig.
MarkdownAutolinkSyntaxAn autolink: a URL or an email address between < and >, or, in GitHub Flavored Markdown, in the text.
MarkdownBlockQuoteSyntaxA block quote: blocks after >.
MarkdownBlockSyntaxA block of a document: a paragraph, a heading, a list, a block quote, a code block...
MarkdownCodeBlockSyntaxA fenced code block (between ``` or ~~~) or an indented code block.
MarkdownCodeSpanSyntaxA code span: code between backticks.
MarkdownConverterConverts Markdown text to HTML or to plain text in one call: it parses the text with MarkdownSyntaxTree.ParseText, then renders the tree with MarkdownHtmlRenderer or MarkdownPlainTextRenderer.
MarkdownCustomContainerSyntaxA custom container: blocks between a fence of three colons or more, :::name arguments, and a fence as long.
MarkdownDefinitionItemSyntaxA definition of a definition list: its terms, the lines of the paragraph before the marker, then its marker, : or ~, and its blocks.
MarkdownDefinitionListSyntaxA definition list: definitions, each with its terms.
MarkdownDefinitionTermSyntaxA term of a definition: a line of inlines.
MarkdownDelimiterExtensionAn inline syntax that wraps content between runs of a character, such as %%highlight%%. The runs take part in the processing of emphasis, as MarkdownExtensions.Inserted (++) and MarkdownExtensions.Marked (==) do, so the construct nests with emphasis in both directions. The construct is a MarkdownExtensionInlineSyntax whose markers are the runs and whose inlines are the content.
MarkdownDocumentSyntaxA Markdown document: its blocks, and the end of the text.
MarkdownEmojiMappingThe shortcodes, such as :smile:, and the smileys, such as :), that MarkdownExtensions.Emoji reads, and their emoji.
MarkdownEmphasisExtraSyntaxAn extra emphasis: subscript (~text~), superscript (^text^), inserted (++text++), marked text (==text==) or an inline custom container (::text::).
MarkdownEmphasisSyntaxAn emphasis (*text*) or a strong emphasis (**text**).
MarkdownEscaperProvides methods to write text into Markdown, so that it is parsed back to the same text instead of being interpreted as Markdown syntax.
MarkdownExtensionBlockSyntaxA block of a MarkdownFencedBlockExtension or of a MarkdownParagraphExtension: its markers, and its lines, its blocks, or its text and inlines.
MarkdownExtensionInlineSyntaxA construct of a MarkdownInlineExtension or of a MarkdownDelimiterExtension: markers, text and inlines, in the order of the text.
MarkdownFencedBlockExtensionA block between an opening line and a closing line, such as !!! note and !!!. The construct is a MarkdownExtensionBlockSyntax: the opening fence, the rest of its line (the info), the content, and the closing fence.
MarkdownFigureCaptionSyntaxThe caption of a figure: the text after one of its fences.
MarkdownFigureSyntaxA figure: blocks between a fence of three carets or more, ^^^, and a fence as long, with the captions after the fences.
MarkdownFooterSyntaxA footer: lines that start with ^^, as a block quote does with >.
MarkdownFootnoteDefinitionSyntaxThe definition of a footnote: [^label]: and its blocks.
MarkdownFootnoteReferenceSyntaxA reference to a footnote: [^label].
MarkdownFormatterWrites a Markdown document in a consistent style, without changing its HTML: one blank line between the blocks, the markers of the containers on every line, the same marker for the bullet lists, ATX headings, fenced code blocks and aligned tables, as MarkdownFormattingOptions configures.
MarkdownFormattingOptionsConfigures how MarkdownFormatter writes a document.
MarkdownFrontMatterSyntaxA YAML front matter at the start of the document, between --- and --- or ....
MarkdownGenericAttributesThe generic attributes of an element: an id, classes, and other attributes, as {#id .class name=value} writes them.
MarkdownGenericAttributesSyntaxGeneric attributes: {#id .class name=value}, which set the HTML attributes of the element of their MarkdownGenericAttributesSyntax.Target.
MarkdownGridTableCellA cell of a grid table: its text is a document of its own.
MarkdownGridTableColumnA column of a grid table.
MarkdownGridTableRowA row of a grid table.
MarkdownGridTableSyntaxA grid table of Markdig: a line of columns, +---+---+, then lines that start with |, whose cells are separated by |, and lines that start with +, which separate the rows. A cell can span columns and rows.
MarkdownHeadingSyntaxAn ATX heading (# Title) or a setext heading (a paragraph underlined by = or -).
MarkdownHtmlBlockSyntaxA block of raw HTML.
MarkdownHtmlNodeRendererWrites the HTML of some nodes instead of MarkdownHtmlRenderer, such as the code blocks of a language or the custom containers of a name. Add it to MarkdownHtmlRendererOptions.NodeRenderers.
MarkdownHtmlRendererRenders a Markdown syntax tree as HTML, as the CommonMark reference implementation does.
MarkdownHtmlRendererOptionsConfigures how MarkdownHtmlRenderer writes HTML.
MarkdownHtmlWriterWrites the HTML of a node for a MarkdownHtmlNodeRenderer: text and attribute values escaped, URLs changed as the options of the renderer change them, the attributes of the node, and its content.
MarkdownInlineExtensionAn inline syntax that starts at one of MarkdownInlineExtension.TriggerCharacters, such as @mention or {{variable}}. The parser calls MarkdownInlineExtension.TryParse at each trigger character, before the built-in syntaxes, and the construct becomes a MarkdownExtensionInlineSyntax.
MarkdownInlineSyntaxAn inline that has a structure: an emphasis, a code span, a link, an autolink, raw HTML...
MarkdownJiraLinkOptionsWhere the links of MarkdownExtensions.JiraLinks go: {BaseUrl}/{BasePath}/{issue}.
MarkdownJiraLinkSyntaxA reference to a Jira issue, such as PROJ-123, which is a link to it.
MarkdownLinkReferenceDefinitionSyntaxA link reference definition: [label]: destination "title".
MarkdownLinkSyntaxA link ([text](destination), [text][label]...) or an image (![description](source)).
MarkdownListItemSyntaxAn item of a list: its marker, and its blocks.
MarkdownListSyntaxA list: list items with the same kind of marker.
MarkdownMathBlockSyntaxA math block: lines of math between $$ lines.
MarkdownMathInlineSyntaxInline math: text between $ or $$.
MarkdownMediaHostCreates the sites of MarkdownMediaLinkOptions.Hosts.
MarkdownMediaLinkOptionsHow MarkdownExtensions.MediaLinks renders the images of audio, video, and of the sites that host them.
MarkdownParagraphExtensionTurns the lines of a paragraph into a block, such as the lines Alice: Hello of a chat transcript. The construct is a MarkdownExtensionBlockSyntax whose parts are markers, text and inlines, as an inline extension reports them.
MarkdownParagraphSyntaxA paragraph: its inlines.
MarkdownParseOptionsConfigures how MarkdownSyntaxTree parses text.
MarkdownPipeTableOptionsHow MarkdownExtensions.PipeTables reads and renders the pipe tables, as the options of the pipe tables of Markdig.
MarkdownPlainTextRendererRenders a Markdown syntax tree as plain text, as MarkdownConverter.ToPlainText of Meziantou.Framework.Markdown 1.x does: the text of the HTML, without its tags and its HTML, and not escaped.
MarkdownRawHtmlSyntaxAn HTML tag, comment, declaration or processing instruction in the text.
MarkdownStrikethroughSyntaxA strikethrough of GitHub Flavored Markdown: text between ~ or ~~.
MarkdownSyntaxExtensionA syntax that the parser reads in addition to CommonMark and to MarkdownExtensions: a MarkdownInlineExtension, a MarkdownDelimiterExtension, a MarkdownFencedBlockExtension or a MarkdownParagraphExtension. Add it to MarkdownParseOptions.SyntaxExtensions.
MarkdownSyntaxNodeThe base of every node of a Markdown syntax tree: a block, an inline, or a part of a table.
MarkdownSyntaxRewriterBuilds a new tree by visiting an old one and returning replacements.
MarkdownSyntaxTreeA parsed Markdown document.
MarkdownSyntaxTreeEditorChanges several blocks of a MarkdownSyntaxTree, and parses the new text once.
MarkdownSyntaxVisitorVisits a Markdown node, calling the method that matches its type.
MarkdownSyntaxVisitor<TResult>Visits a Markdown node, calling the method that matches its type, and returns a result.
MarkdownSyntaxWalkerVisits a Markdown node and everything below it.
MarkdownTableCellSyntaxA cell of a row of a table: its inlines.
MarkdownTableRowSyntaxA row of a table: its cells, and the pipes between them.
MarkdownTableSyntaxA table of GitHub Flavored Markdown, or a pipe table of Markdig: a header row, a delimiter row, and the other rows. A pipe table that MarkdownPipeTableOptions.RequireHeaderSeparator allows has only the other rows.
MarkdownThematicBreakSyntaxA thematic break: ---, *** or ___.

Structs

NameDescription
MarkdownFencedBlockContextA block of a MarkdownFencedBlockExtension that is closed, for MarkdownFencedBlockExtension.OnClosed.
MarkdownInlineParseContextThe text where a MarkdownInlineExtension reads a construct, and where it reports the parts of the construct: markers, text, and nested inlines. The positions are relative to the start of MarkdownInlineParseContext.Text.
MarkdownParagraphConvertContextThe lines of a paragraph that a MarkdownParagraphExtension reads, and where it reports the parts of its block: markers, text and inlines, each on one line. The positions are relative to the start of their line.

Interfaces

NameDescription
IMarkdownMediaHostA site whose links MarkdownExtensions.MediaLinks renders as an <iframe>.

Enums

NameDescription
MarkdownAutoIdentifierOptionsConfigures how MarkdownExtensions.AutoIdentifiers makes the identifiers of the headings.
MarkdownEmphasisExtraStyleThe style of an extra emphasis.
MarkdownExtensionsThe extensions of CommonMark that a MarkdownSyntaxTree parses.
MarkdownFencedBlockContentWhat the lines between the fences of a MarkdownFencedBlockExtension are.
MarkdownLinkKindHow a link or an image gives its destination.
MarkdownOrderedListStyleHow the items of an ordered list are numbered.
MarkdownSmartyPantThe typographic character that MarkdownExtensions.SmartyPants writes instead of ASCII punctuation. It is the SyntaxToken.Value of a SyntaxKind.SmartyPantToken.
MarkdownTableAlignmentThe alignment of a column of a table, which the colons of its cell of the delimiter row give.
SyntaxKindThe kinds of the nodes, tokens and trivia of a Markdown syntax tree.