Meziantou.FrameworkMarkdownPipelineBuilder Class
This class allows to modify the pipeline to parse and render a Markdown document.
public class MarkdownPipelineBuilderRemarks
NOTE: A pipeline is not thread-safe.
Constructors
| Name | Description |
|---|---|
| MarkdownPipelineBuilder() | Initializes a new instance of the MarkdownPipeline class. |
MarkdownPipelineBuilder()
MarkdownPipelineBuilder.csInitializes a new instance of the MarkdownPipeline class.
public MarkdownPipelineBuilder()Properties
| Name | Description |
|---|---|
| BlockParsers | Gets the block parsers. |
| DebugLog | Gets or sets the debug log. |
| Extensions | Gets the register extensions. |
| InlineParsers | Gets the inline parsers. |
| MaximumNestingDepth | Gets or sets the maximum nesting depth allowed for the Markdown syntax tree during parsing and rendering. |
| PreciseSourceLocation | Gets or sets a value indicating whether to enable precise source location (slower parsing but accurate position for block and inline elements) |
| TrackTrivia | True to parse trivia such as whitespace, extra heading characters and unescaped string values. |
BlockParsers
MarkdownPipelineBuilder.csDebugLog
MarkdownPipelineBuilder.csExtensions
MarkdownPipelineBuilder.csGets the register extensions.
public OrderedList<IMarkdownExtension> Extensions { get; }Property value
InlineParsers
MarkdownPipelineBuilder.csMaximumNestingDepth
MarkdownPipelineBuilder.csGets or sets the maximum nesting depth allowed for the Markdown syntax tree during parsing and rendering.
public int MaximumNestingDepth { get; set; }Property value
Exceptions
ArgumentOutOfRangeException- Thrown when the value is less than or equal to zero.
Remarks
The default value is 128. Raising this value allows deeper documents but can increase parsing cost and rendering stack usage.
PreciseSourceLocation
MarkdownPipelineBuilder.csTrackTrivia
MarkdownPipelineBuilder.csMethods
| Name | Description |
|---|---|
| Build() | Builds a pipeline from this instance. Once the pipeline is build, it cannot be modified. |
Build()
MarkdownPipelineBuilder.csBuilds a pipeline from this instance. Once the pipeline is build, it cannot be modified.
public MarkdownPipeline Build()Events
| Name | Description |
|---|---|
| DocumentProcessed | Occurs when a document has been processed after the MarkdownParser.Parse method. |
DocumentProcessed
Occurs when a document has been processed after the MarkdownParser.Parse method.
public event ProcessDocumentDelegate? DocumentProcessed