Class MarkdownEngine

    Inheritance
    Object
    MarkdownEngine
    DfmEngine
    Inherited Members
    Namespace:Microsoft.DocAsCode.MarkdownLite
    Assembly:Microsoft.DocAsCode.MarkdownLite.dll
    Syntax
    public class MarkdownEngine : IMarkdownEngine

    Constructors

    MarkdownEngine(IMarkdownContext, IMarkdownTokenRewriter, Object, Options)

    Declaration
    public MarkdownEngine(IMarkdownContext context, IMarkdownTokenRewriter rewriter, object renderer, Options options)
    Parameters
    Type Name Description
    IMarkdownContext context
    IMarkdownTokenRewriter rewriter
    Object renderer
    Options options

    MarkdownEngine(IMarkdownContext, IMarkdownTokenRewriter, Object, Options, Dictionary<String, LinkObj>)

    Declaration
    protected MarkdownEngine(IMarkdownContext context, IMarkdownTokenRewriter rewriter, object renderer, Options options, Dictionary<string, LinkObj> links)
    Parameters
    Type Name Description
    IMarkdownContext context
    IMarkdownTokenRewriter rewriter
    Object renderer
    Options options
    Dictionary<String, LinkObj> links

    MarkdownEngine(IMarkdownContext, Object, Options)

    Declaration
    public MarkdownEngine(IMarkdownContext context, object renderer, Options options)
    Parameters
    Type Name Description
    IMarkdownContext context
    Object renderer
    Options options

    Properties

    Context

    Declaration
    public IMarkdownContext Context { get; }
    Property Value
    Type Description
    IMarkdownContext
    Declaration
    public Dictionary<string, LinkObj> Links { get; }
    Property Value
    Type Description
    Dictionary<String, LinkObj>

    MaxExtractCount

    Declaration
    public int MaxExtractCount { get; set; }
    Property Value
    Type Description
    Int32

    Options

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

    Parser

    Declaration
    public virtual IMarkdownParser Parser { get; }
    Property Value
    Type Description
    IMarkdownParser
    Implements

    Renderer

    Declaration
    public virtual IMarkdownRenderer Renderer { get; }
    Property Value
    Type Description
    IMarkdownRenderer
    Implements

    RendererImpl

    Declaration
    public object RendererImpl { get; }
    Property Value
    Type Description
    Object

    RewriteEngine

    Declaration
    public virtual IMarkdownRewriteEngine RewriteEngine { get; }
    Property Value
    Type Description
    IMarkdownRewriteEngine
    Implements

    Rewriter

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

    TokenTreeValidator

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

    Methods

    Mark(SourceInfo, IMarkdownContext)

    Declaration
    public StringBuffer Mark(SourceInfo sourceInfo, IMarkdownContext context)
    Parameters
    Type Name Description
    SourceInfo sourceInfo
    IMarkdownContext context
    Returns
    Type Description
    StringBuffer
    Implements

    Markup(String, String)

    Declaration
    public virtual string Markup(string markdown, string file)
    Parameters
    Type Name Description
    String markdown
    String file
    Returns
    Type Description
    String
    Implements

    Normalize(String)

    Declaration
    public static string Normalize(string markdown)
    Parameters
    Type Name Description
    String markdown
    Returns
    Type Description
    String

    Preprocess(String)

    Declaration
    protected virtual string Preprocess(string src)
    Parameters
    Type Name Description
    String src
    Returns
    Type Description
    String

    Extension Methods