Interface IRenderOptions

The options for the renderMarkdown function.

interface IRenderOptions {
    host: HTMLElement;
    latexTypesetter: null | IRenderMime.ILatexTypesetter;
    linkHandler: null | IRenderMime.ILinkHandler;
    markdownParser: null | IRenderMime.IMarkdownParser;
    resolver: null | IRenderMime.IResolver;
    sanitizer: IRenderMime.ISanitizer;
    shouldTypeset: boolean;
    source: string;
    translator?: ITranslator;
    trusted: boolean;
}

Properties

host latexTypesetter linkHandler markdownParser resolver sanitizer shouldTypeset source translator? trusted

Properties

host

host: HTMLElement

The host node for the rendered Markdown.

latexTypesetter

latexTypesetter: null | IRenderMime.ILatexTypesetter

The LaTeX typesetter for the application.

linkHandler

linkHandler: null | IRenderMime.ILinkHandler

An optional link handler.

markdownParser

markdownParser: null | IRenderMime.IMarkdownParser

The Markdown parser.

resolver

resolver: null | IRenderMime.IResolver

An optional url resolver.

sanitizer

sanitizer: IRenderMime.ISanitizer

The html sanitizer for untrusted source.

shouldTypeset

shouldTypeset: boolean

Whether the node should be typeset.

source

source: string

The Markdown source to render.

Optional translator

translator?: ITranslator

The application language translator.

trusted

trusted: boolean

Whether the source is trusted.

Settings

Member Visibility

Theme

On This Page

hostlatexTypesetterlinkHandlermarkdownParserresolversanitizershouldTypesetsourcetranslatortrusted