Class MarkdownDocumentToHtmlConverter

Inheritance

System.Object

MarkdownDocumentToHtmlConverter

Implements

IDocumentToHtmlConverter

ITransientDependency

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Volo.Docs.Markdown

Assembly: Volo.Docs.Web.dll

Syntax

public class MarkdownDocumentToHtmlConverter : IDocumentToHtmlConverter, ITransientDependency

Constructors

MarkdownDocumentToHtmlConverter(IMarkdownConverter, IOptions<DocsUiOptions>)

Declaration

public MarkdownDocumentToHtmlConverter(IMarkdownConverter markdownConverter, IOptions<DocsUiOptions> urlOptions)

Parameters

Type	Name	Description
IMarkdownConverter	markdownConverter
IOptions<DocsUiOptions>	urlOptions

Fields

Type

Declaration

public const string Type = "md"

Field Value

Type	Description
System.String

Methods

Convert(ProjectDto, DocumentWithDetailsDto, String, String)

Declaration

public virtual string Convert(ProjectDto project, DocumentWithDetailsDto document, string version, string languageCode)

Parameters

Type	Name	Description
ProjectDto	project
DocumentWithDetailsDto	document
System.String	version
System.String	languageCode

Returns

Type	Description
System.String

NormalizeLinks(String, String, String, String, String)

Declaration

protected virtual string NormalizeLinks(string content, string projectShortName, string version, string documentLocalDirectory, string languageCode)

Parameters

Type	Name	Description
System.String	content
System.String	projectShortName
System.String	version
System.String	documentLocalDirectory
System.String	languageCode

Returns

Type	Description
System.String

Implements

IDocumentToHtmlConverter

ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(Object)

AbpObjectExtensions.To<T>(Object)

AbpObjectExtensions.IsIn<T>(T, T[])

AbpObjectExtensions.If<T>(T, Boolean, Func<T, T>)

AbpObjectExtensions.If<T>(T, Boolean, Action<T>)

LockExtensions.Locking(Object, Action)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<TResult>(Object, Func<TResult>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)