Options
All
  • Public
  • Public/Protected
  • All
Menu

GitHubMarkdown

Drafts includes Discount-based, GitHub flavored Markdown parser based on GHMarkdownParser. For details on the meaning of the various options, refer to Markdown documentation.

Example

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

var outputString = md.render(inputString);

Hierarchy

  • GitHubMarkdown

Index

Properties

autoLinks

autoLinks: boolean

defaults to false

noImages

noImages: boolean

defaults to true

noLinks

noLinks: boolean

defaults to true

removeHTMLTags

removeHTMLTags: boolean

defaults to false

safeLinks

safeLinks: boolean

defaults to true

smartQuotesEnabled

smartQuotesEnabled: boolean

defaults to true

strict

strict: boolean

defaults to false

Methods

render

  • render(markdownStr: string): string
  • Takes Markdown string passed and processes it with GitHub Markdown parser based on the property 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