Class MarkdownEngineBuilder

    A builder for create an instance of IMarkdownEngine

    Inheritance
    Object
    MarkdownEngineBuilder
    GfmEngineBuilder
    MarkdownEngineByOptionsBuilder
    Inherited Members
    Namespace:Microsoft.DocAsCode.MarkdownLite
    Assembly:Microsoft.DocAsCode.MarkdownLite.dll
    Syntax
    public class MarkdownEngineBuilder

    Constructors

    MarkdownEngineBuilder(Options)

    Declaration
    public MarkdownEngineBuilder(Options options)
    Parameters
    Type Name Description
    Options options

    Properties

    BlockRules

    The block rules.

    Declaration
    public ImmutableList<IMarkdownRule> BlockRules { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableList<IMarkdownRule>

    InlineRules

    The inline rules.

    Declaration
    public ImmutableList<IMarkdownRule> InlineRules { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableList<IMarkdownRule>

    Options

    The options.

    Declaration
    public Options Options { get; }
    Property Value
    Type Description
    Options

    Rewriter

    The markdown token rewriter.

    Declaration
    public IMarkdownTokenRewriter Rewriter { get; set; }
    Property Value
    Type Description
    IMarkdownTokenRewriter

    TokenTreeValidator

    The markdown token tree validator.

    Declaration
    public IMarkdownTokenTreeValidator TokenTreeValidator { get; set; }
    Property Value
    Type Description
    IMarkdownTokenTreeValidator

    Methods

    CreateEngine(Object)

    Create an instance of IMarkdownEngine

    Declaration
    public virtual IMarkdownEngine CreateEngine(object renderer)
    Parameters
    Type Name Description
    Object renderer

    the renderer.
    Returns
    Type Description
    IMarkdownEngine

    an instance of IMarkdownEngine

    CreateParseContext()

    Create markdown paring context.

    Declaration
    protected virtual IMarkdownContext CreateParseContext()
    Returns
    Type Description
    IMarkdownContext

    a instance of IMarkdownContext

    Extension Methods