Class MarkdownEngine

Inheritance
Object
MarkdownEngine
DfmEngine
Implements
Inherited Members
Namespace: Microsoft.DocAsCode.MarkdownLite
Assembly: Microsoft.DocAsCode.MarkdownLite.dll
Syntax
public class MarkdownEngine : IMarkdownEngine

Constructors

| Improve this Doc View Source

MarkdownEngine(IMarkdownContext, IMarkdownTokenRewriter, Object, Options)

Declaration
public MarkdownEngine(IMarkdownContext context, IMarkdownTokenRewriter rewriter, object renderer, Options options)
Parameters
Type Name Description
IMarkdownContext context
IMarkdownTokenRewriter rewriter
Object renderer
Options options
| Improve this Doc View Source

MarkdownEngine(IMarkdownContext, IMarkdownTokenRewriter, Object, Options, Dictionary<String, LinkObj>)

Declaration
protected MarkdownEngine(IMarkdownContext context, IMarkdownTokenRewriter rewriter, object renderer, Options options, Dictionary<string, LinkObj> links)
Parameters
Type Name Description
IMarkdownContext context
IMarkdownTokenRewriter rewriter
Object renderer
Options options
Dictionary<String, LinkObj> links
| Improve this Doc View Source

MarkdownEngine(IMarkdownContext, Object, Options)

Declaration
public MarkdownEngine(IMarkdownContext context, object renderer, Options options)
Parameters
Type Name Description
IMarkdownContext context
Object renderer
Options options

Properties

| Improve this Doc View Source

Context

Declaration
public IMarkdownContext Context { get; }
Property Value
Type Description
IMarkdownContext
| Improve this Doc View Source
Declaration
public Dictionary<string, LinkObj> Links { get; }
Property Value
Type Description
Dictionary<String, LinkObj>
| Improve this Doc View Source

MaxExtractCount

Declaration
public int MaxExtractCount { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Options

Declaration
public Options Options { get; }
Property Value
Type Description
Options
| Improve this Doc View Source

Parser

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

Renderer

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

RendererImpl

Declaration
public object RendererImpl { get; }
Property Value
Type Description
Object
| Improve this Doc View Source

RewriteEngine

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

Rewriter

Declaration
public IMarkdownTokenRewriter Rewriter { get; }
Property Value
Type Description
IMarkdownTokenRewriter
| Improve this Doc View Source

TokenAggregator

Declaration
[Obsolete]
public IMarkdownTokenAggregator TokenAggregator { get; set; }
Property Value
Type Description
IMarkdownTokenAggregator
| Improve this Doc View Source

TokenAggregators

Declaration
public ImmutableList<IMarkdownTokenAggregator> TokenAggregators { get; set; }
Property Value
Type Description
ImmutableList<IMarkdownTokenAggregator>
| Improve this Doc View Source

TokenTreeValidator

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

Methods

| Improve this Doc View Source

Mark(SourceInfo, IMarkdownContext)

Declaration
public StringBuffer Mark(SourceInfo sourceInfo, IMarkdownContext context)
Parameters
Type Name Description
SourceInfo sourceInfo
IMarkdownContext context
Returns
Type Description
StringBuffer
| Improve this Doc View Source

Markup(String, String)

Declaration
public virtual string Markup(string markdown, string file)
Parameters
Type Name Description
String markdown
String file
Returns
Type Description
String
| Improve this Doc View Source

Normalize(String)

Declaration
public static string Normalize(string markdown)
Parameters
Type Name Description
String markdown
Returns
Type Description
String
| Improve this Doc View Source

Preprocess(String)

Declaration
protected virtual string Preprocess(string src)
Parameters
Type Name Description
String src
Returns
Type Description
String

Implements

Extension Methods