1. Home
  2. API
  3. Markdig.Syntax
  4. MarkdownDocument

MarkdownDocument Class

Definition

Namespace Markdig.Syntax
Assembly Markdig.dll
View source
Show inherited members (51)

The root Markdown document.

public class MarkdownDocument : ContainerBlock, IBlock, IMarkdownObject, IList<Block>, ICollection<Block>, IReadOnlyList<Block>, IReadOnlyCollection<Block>, IEnumerable<Block>, IEnumerable
Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (1)

MarkdownDocument()Initializes a new instance of the MarkdownDocument class.

Fields (1)

LineCountGets the number of lines in this MarkdownDocument

Properties (1)

LineStartIndexesGets a list of zero-based indexes of line beginnings in the source span Available if PreciseSourceLocation is used, otherwise null

Extensions (10)

ToHtml(MarkdownDocument, MarkdownPipeline?)Converts a Markdown document to HTML.
ToHtml(MarkdownDocument, TextWriter, MarkdownPipeline?)Converts a Markdown document to HTML.
AddAbbreviation(MarkdownDocument, String, Abbreviation)Adds abbreviation.
GetAbbreviations(MarkdownDocument)Gets abbreviations.
HasAbbreviations(MarkdownDocument)Determines whether abbreviations.
FindClosestLine(MarkdownDocument, Int32)Performs the find closest line operation.
ContainsLinkReferenceDefinition(MarkdownDocument, String)Performs the contains link reference definition operation.
GetLinkReferenceDefinitions(MarkdownDocument, Boolean)Gets link reference definitions.
SetLinkReferenceDefinition(MarkdownDocument, String, LinkReferenceDefinition, Boolean)Sets link reference definition.
TryGetLinkReferenceDefinition(MarkdownDocument, String, out LinkReferenceDefinition?)Attempts to get link reference definition.