WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MarkedOptions

Index

Properties

breaks

breaks: boolean

Enable GFM line breaks. This option requires the gfm option to be true.

gfm

gfm: boolean

Enable GitHub flavored markdown.

langPrefix

langPrefix: string

Set the prefix for code block classes.

pedantic

pedantic: boolean

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

renderer

renderer: MarkedRenderer

Type: object Default: new Renderer()

An object containing functions to render tokens to HTML.

sanitize

sanitize: boolean

Sanitize the output. Ignore any HTML that has been input.

silent

silent: boolean

Shows an HTML error message when rendering fails.

smartLists

smartLists: boolean

Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.

smartypants

smartypants: boolean

Use "smart" typograhic punctuation for things like quotes and dashes.

tables

tables: boolean

Enable GFM tables. This option requires the gfm option to be true.

Methods

highlight

  • highlight(code: string, lang: string, callback?: Function): string
  • A function to highlight code blocks. The function takes three arguments: code, lang, and callback.

    Parameters

    • code: string
    • lang: string
    • Optional callback: Function

    Returns string

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