Options
All
  • Public
  • Public/Protected
  • All
Menu

MultiMarkdown

Drafts includes a full version of the MultiMarkdown 6 engine to render Markdown text to HTML and other supported formats. For details on the meaning of the various options, refer to MultiMarkdown documentation.

Example

var inputString = "# Header\n\nMy **markdown** text";
var mmd = MultiMarkdown.create();

mmd.format = "html";
mmd.criticMarkup = true;
var outputString = mmd.render(inputString);

Hierarchy

  • MultiMarkdown

Index

Properties

completeDocument

completeDocument: boolean

defaults to false

criticMarkup

criticMarkup: boolean

defaults to false

criticMarkupAccept

criticMarkupAccept: boolean

defaults to false

criticMarkupReject

criticMarkupReject: boolean

defaults to false

footnotesEnabled

footnotesEnabled: boolean

defaults to true

format

format: "html" | "epub" | "latex" | "beamer" | "memoir" | "odt" | "mmd"

Specify output format. Valid values are:

  • html: HTML. This is the default Markdown output.
  • epub: ePub
  • latex: LaTeX
  • beamer
  • memoir
  • odt: Open document format
  • mmd

markdownCompatibilityMode

markdownCompatibilityMode: boolean

defaults to false

noLabels

noLabels: boolean

defaults to true

noMetadata

noMetadata: boolean

defaults to false

obfuscate

obfuscate: boolean

defaults to false

processHTML

processHTML: boolean

defaults to true

randomFootnotes

randomFootnotes: boolean

defaults to false

smartQuotesEnabled

smartQuotesEnabled: boolean

defaults to true

snippetOnly

snippetOnly: boolean

defaults to false

transclude

transclude: boolean

defaults to false

Methods

render

  • render(markdownStr: string): string
  • Takes Markdown string passed and processes it with MultiMarkdown based on the properties and format selections on the object.

    Parameters

    • markdownStr: string

    Returns string

Static create

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc