Interface IMarkdownRewriteEngine

    Markdown rewrite engine.

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

    Properties

    Engine

    Get markdown engine.

    Declaration
    IMarkdownEngine Engine { get; }
    Property Value
    Type Description
    IMarkdownEngine

    Methods

    Complete()

    Declaration
    void Complete()

    GetParents()

    Declaration
    ImmutableArray<IMarkdownToken> GetParents()
    Returns
    Type Description
    System.Collections.Immutable.ImmutableArray<IMarkdownToken>

    GetVariable(String)

    Declaration
    object GetVariable(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Object

    HasPostProcess(String)

    Declaration
    bool HasPostProcess(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Boolean

    HasVariable(String)

    Declaration
    bool HasVariable(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Boolean

    Initialize()

    Declaration
    void Initialize()

    RemovePostProcess(String)

    Declaration
    void RemovePostProcess(string name)
    Parameters
    Type Name Description
    String name

    RemoveVariable(String)

    Declaration
    void RemoveVariable(string name)
    Parameters
    Type Name Description
    String name

    Rewrite(ImmutableArray<IMarkdownToken>)

    Rewrite markdown tokens.

    Declaration
    ImmutableArray<IMarkdownToken> Rewrite(ImmutableArray<IMarkdownToken> tokens)
    Parameters
    Type Name Description
    System.Collections.Immutable.ImmutableArray<IMarkdownToken> tokens

    Source markdown tokens.
    Returns
    Type Description
    System.Collections.Immutable.ImmutableArray<IMarkdownToken>

    Rewritten markdown tokens.

    SetPostProcess(String, Action<IMarkdownRewriteEngine>)

    Declaration
    void SetPostProcess(string name, Action<IMarkdownRewriteEngine> action)
    Parameters
    Type Name Description
    String name
    Action<IMarkdownRewriteEngine> action

    SetVariable(String, Object)

    Declaration
    void SetVariable(string name, object value)
    Parameters
    Type Name Description
    String name
    Object value

    Extension Methods