Show / Hide Table of Contents

    Interface IMarkdownContext

    The context for markdown parser. It should be immutable.

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

    Properties

    Rules

    Get the rule set for current context.

    Declaration
    ImmutableList<IMarkdownRule> Rules { get; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableList<IMarkdownRule>

    Variables

    Get the variables.

    Declaration
    ImmutableDictionary<string, object> Variables { get; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableDictionary<String, Object>

    Methods

    CreateContext(ImmutableDictionary<String, Object>)

    Create a new context with different variables.

    Declaration
    IMarkdownContext CreateContext(ImmutableDictionary<string, object> variables)
    Parameters
    Type Name Description
    System.Collections.Immutable.ImmutableDictionary<String, Object> variables

    The new variables.

    Returns
    Type Description
    IMarkdownContext

    a new instance of IMarkdownContext

    Extension Methods

    DfmContextExtensions.GetFilePathStack(IMarkdownContext)
    DfmContextExtensions.SetFilePathStack(IMarkdownContext, ImmutableStack<String>)
    DfmContextExtensions.GetBaseFolder(IMarkdownContext)
    DfmContextExtensions.SetBaseFolder(IMarkdownContext, String)
    DfmContextExtensions.GetFallbackFolders(IMarkdownContext)
    DfmContextExtensions.SetFallbackFolders(IMarkdownContext, IReadOnlyList<String>)
    DfmContextExtensions.SetDependency(IMarkdownContext, HashSet<String>)
    DfmContextExtensions.ReportDependency(IMarkdownContext, String)
    DfmContextExtensions.ReportDependency(IMarkdownContext, IEnumerable<String>)
    DfmContextExtensions.GetIsInclude(IMarkdownContext)
    DfmContextExtensions.SetIsInclude(IMarkdownContext)
    JsonUtility.ToJsonString(Object, Formatting, JsonSerializer)
    Back to top Copyright © 2015-2017 Microsoft
    Generated by DocFX