Markdown

Markdown adds a topic type you write in Markdown (GitHub Flavored Markdown) instead of the rich text editor. It suits teams who already write in Markdown, for example developers moving content from a code repository, or anyone who prefers keyboard shortcuts and plain-text formatting.

Category: Authoring · Status: Beta · Plan: all plans · Requires: nothing

Create a Markdown topic

• From Home: select New, then Markdown under Topics.
• Inside a document: select New in the topic tree, then Markdown.

Write in Markdown

The Markdown editor shows formatted text as you type. Type Markdown syntax directly, for example ## for a heading or - for a list, or use the toolbar:

• Heading 1, 2, and 3
• Bold, italic, strikethrough, and inline code
• Code block
• Bullet list, numbered list, and task list
• Blockquote, link, and table

When you paste Markdown text, it is converted to formatting automatically. Save and publish Markdown topics as usual. Readers see them formatted in the viewer, like any other topic.

Limits

• The Markdown toolbar has no image upload button.
• Raw HTML inside Markdown isn't supported.

If you uninstall it

The Markdown options disappear from the New menus. Existing Markdown topics keep showing for readers, but you can't edit them until you install the addon again.