Interface IMarkdownRewriteEngine

    Markdown rewrite engine.

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

    Properties

    | Improve this Doc View Source

    Engine

    Get markdown engine.

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

    Methods

    | Improve this Doc View Source

    Complete()

    Declaration
    void Complete()
    | Improve this Doc View Source

    GetParents()

    Declaration
    ImmutableArray<IMarkdownToken> GetParents()
    Returns
    Type Description
    System.Collections.Immutable.ImmutableArray<IMarkdownToken>
    | Improve this Doc View Source

    GetVariable(String)

    Declaration
    object GetVariable(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Object
    | Improve this Doc View Source

    HasPostProcess(String)

    Declaration
    bool HasPostProcess(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    HasVariable(String)

    Declaration
    bool HasVariable(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    Boolean
    | Improve this Doc View Source

    Initialize()

    Declaration
    void Initialize()
    | Improve this Doc View Source

    RemovePostProcess(String)

    Declaration
    void RemovePostProcess(string name)
    Parameters
    Type Name Description
    String name
    | Improve this Doc View Source

    RemoveVariable(String)

    Declaration
    void RemoveVariable(string name)
    Parameters
    Type Name Description
    String name
    | Improve this Doc View Source

    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.
    | Improve this Doc View Source

    SetPostProcess(String, Action<IMarkdownRewriteEngine>)

    Declaration
    void SetPostProcess(string name, Action<IMarkdownRewriteEngine> action)
    Parameters
    Type Name Description
    String name
    Action<IMarkdownRewriteEngine> action
    | Improve this Doc View Source

    SetVariable(String, Object)

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

    Extension Methods