Markdown Options

NOTE: Markdown options configured on this screen affect the default conversion of Markdown when used in action templates - which also controls how Markdown is output in previews. These settings do not affect syntax highlighting in the editor.

Markdown is plain text markup language that allows easy conversion to other formats, primarily HTML. Drafts ships with support for syntax highlighting of Markdown in it’s editor - but also ships with two configurable Markdown parsers to convert your Markdown text to HTML for previewing or output in actions and templates.

Markdown has been extended over the years in a number of ways, and for flexibility, Drafts provides two popular Markdown parsing options, each of which have a number of customizable settings detailed below.

If you are new to Markdown, or only use it casually for simple markup, you will likely not need to alter these settings from the defaults, but for advanced users looking to control their Markdown output in more detail, they may come in handy.

MultiMarkdown

MultiMarkdown is a Markdown parser by Fletcher Penney which adds a number of powerful extensions to the original Markdown specification including tables and footnotes. Drafts includes MultiMarkdown 6. More details about MultiMarkdown syntax and extensions can be found in the user guide.

The following options are available for rendering with MultiMarkdown:

  • Markdown compatibility mode: Treat input as plain Markdown with out MultiMarkdown extensions enabled.
  • Smart quotes: Replace straight quotes
  • Escaped link breaks: If enabled, the \ character can be used to force a new line
  • Footnotes: Enable or disable footnote syntax
  • Random footnotes: Use randomized identifier numbers for footnotes
  • No labels: Enable or disable adding of id attributes to headers
  • Process HTML: If enabled, text inside HTML tags will be processed
  • No metadata: Disable special handling of meta data at the top of documents
  • Obfuscate: If enabled, email address will be obfuscated in HTML output
  • Critic markup: Enable Critic Markup.

GitHub Flavored

Drafts includes a Markdown parser based on Discount which supports extensions to the Markdown specification made by GitHub. This is the type of Markdown used in GitHub and includes extensions for strikethrough text, tables. More details are available in GitHub’s documentation.

The following options are available for rendering with GitHub Flavored Markdown:

  • Smart Quotes: Replace straight quotes
  • Disable images: Do not allow images
  • Disable links: Do not allow links at all
  • Safe links: Only allow http:, https: and ftp: links
  • Auto links: Convert URLs in the input to links automatically
  • Strict: Do not allow emphasis mid-word
  • Disable HTML tags: Do not allow HTML tags in the input