Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GitHubMarkdown

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

Constructors

Properties

Methods

Constructors

constructor

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

Generated using TypeDoc