Interface IMarkdownEngine

    Markdown engine

    Namespace:Microsoft.DocAsCode.MarkdownLite
    Assembly:Microsoft.DocAsCode.MarkdownLite.dll
    Syntax
    public interface IMarkdownEngine

    Properties

    | Improve this Doc View Source

    Parser

    Get the parser (it can read markdown text, then return markdown tokens).

    Declaration
    IMarkdownParser Parser { get; }
    Property Value
    Type Description
    IMarkdownParser
    | Improve this Doc View Source

    Renderer

    Get the renderer (it can read markdown token, then return text e.g. html).

    Declaration
    IMarkdownRenderer Renderer { get; }
    Property Value
    Type Description
    IMarkdownRenderer
    | Improve this Doc View Source

    RewriteEngine

    Get the rewriter (it can read markdown tokens, then rewrite them and return).

    Declaration
    IMarkdownRewriteEngine RewriteEngine { get; }
    Property Value
    Type Description
    IMarkdownRewriteEngine
    | Improve this Doc View Source

    TokenTreeValidator

    Get the token tree validator.

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

    Methods

    | Improve this Doc View Source

    Mark(SourceInfo, IMarkdownContext)

    Mark markdown text.

    Declaration
    StringBuffer Mark(SourceInfo sourceInfo, IMarkdownContext context = null)
    Parameters
    Type Name Description
    SourceInfo sourceInfo

    The line info for markdown text.
    IMarkdownContext context

    The markdown context contains rules.
    Returns
    Type Description
    StringBuffer

    Rendered text.
    | Improve this Doc View Source

    Markup(String, String)

    Mark markdown text.

    Declaration
    string Markup(string markdown, string file = null)
    Parameters
    Type Name Description
    String markdown

    The markdown text.
    String file

    The file of markdown.
    Returns
    Type Description
    String

    Rendered text.

    Extension Methods