Markdown2Pdf.Options.ModuleOptions

Class ModuleOptions

Namespace: Markdown2Pdf.Options
Assembly: Markdown2Pdf.dll

Options that decide from where to load additional modules.

public class ModuleOptions

Inheritance

object ← ModuleOptions

Derived

NodeModuleOptions

Inherited Members

object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Remarks

For the option String) the npm packages specified in the README need to be installed.

Properties

ModuleLocation

Provides information from where to load modules.

public ModuleLocation ModuleLocation { get; }

Property Value

ModuleLocation

None

Don't load any additional modules. With this only basic markdown features are enabled.

public static ModuleOptions None { get; }

Property Value

ModuleOptions

Remote

Loads the node_modules over a CDN e.g. https://cdn.jsdelivr.net.

public static ModuleOptions Remote { get; }

Property Value

ModuleOptions

Remarks

This option requires an internet connection.

Methods

FromLocalPath(string)

Loads the node_modules from the given (local) npm directory.

public static ModuleOptions FromLocalPath(string modulePath)

Parameters

modulePath string

The path to the node_module directory.

Returns

ModuleOptions

Remarks

For this to work, following npm packages need to be installed:

npm i mathjax@3
npm i mermaid@10
npm i font-awesome
npm i @highlightjs/cdn-assets@11
npm i github-markdown-css
npm i latex.css