MarkdownItOptions Class

Provides options to use with ConvertMarkdownToHtml(FileInfo, MarkdownItPreset, MarkdownItOptions, Encoding) function.

Definition

Namespace: DevCase.Core.DataProcessing.Markdown
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
C#Request Example
public class MarkdownItOptions
Inheritance
Object    MarkdownItOptions

Remarks

Note: To use this functionality you need to install this nuget package:

Microsoft.ClearScript.V8

Constructors

MarkdownItOptions Initializes a new instance of the MarkdownItOptions class.

Properties

BreakLines Gets or sets a value indicating to convert '\n' line breaks to <br> tags.

Default value: false.

Html Gets or sets a value indicating to enable HTML tags in source markdown string.

Be careful! That's not safe! You may need external sanitizer to protect output from XSS.

Default value: false.

LangPrefix Gets or sets the CSS language class prefix for fenced blocks.

Can be useful for external highlighters.

Default value: 'language-'

Linkify Gets or sets a value indicating to autoconvert URL-like text to links.

Default value: false.

Quotes Gets or sets the double + single quotes replacement pairs when Typographer is True and smartquotes on.

For example, you can use `'«»„“'` for Russian, `'„“‚‘'` for German, and `['«\xA0', '\xA0»', '‹\xA0', '\xA0›']` for French (including nbsp).

Default value: “”‘’

Typographer Gets or sets a value indicating to enable some language-neutral replacement (https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.js) + quotes beautification (smartquotes).

Default value: false.

XhtmlOutput Gets or sets a value indicating to add '/' when closing single tags. (<br />).

This is needed only for full CommonMark compatibility. In real world you will need HTML output.

Default value: false.

Methods

Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the Type of the current instance.
(Inherited from Object)
ToString Returns a string that represents the current object.
(Inherited from Object)

Extension Methods

CanConvertTo Determines whether the source object can be converted to the specified target type.
(Defined by ObjectExtensions)
CanConvertToT Determines whether the source object can be converted to the specified target type.
(Defined by ObjectExtensions)
ConvertToT Converts an object to the specified target type.

If the conversion fails, an exception is thrown.
(Defined by ObjectExtensions)
ConvertToT Converts an object to the specified target type.

If the conversion fails, returns the specified default value.
(Defined by ObjectExtensions)
IsDisposable Determines whether the specified object is a disposable type (i.e., it implements IDisposable interface).
(Defined by ObjectExtensions)
Speak Speaks the string representation of the source object by using the operating system integrated text-to-speech synthesizer.
(Defined by ObjectExtensions)
Speak Speaks the string representation of the source object by using the operating system integrated text-to-speech synthesizer.
(Defined by ObjectExtensions)
ThrowIfNullTException Throws the specified exception if the source object is null.
(Defined by ObjectExtensions)

See Also