Interface IMarkdownRule

    Markdown rule.

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

    Properties

    | Improve this Doc View Source

    Name

    Get the name of rule.

    Declaration
    string Name { get; }
    Property Value
    Type Description
    String

    Methods

    | Improve this Doc View Source

    TryMatch(IMarkdownParser, IMarkdownParsingContext)

    Try match this rule.

    Declaration
    IMarkdownToken TryMatch(IMarkdownParser parser, IMarkdownParsingContext context)
    Parameters
    Type Name Description
    IMarkdownParser parser

    The markdown parser.
    IMarkdownParsingContext context

    The context for parser, contains markdown text, line number and file.
    Returns
    Type Description
    IMarkdownToken

    If matched, an instance of IMarkdownToken should be return, otherwise null.

    Extension Methods