Skip to content

GitHub Flavored Markdown ​

Markpion renders GitHub Flavored Markdown (GFM), the Markdown dialect used on GitHub, through the remark-gfm parser plugin. Documents you write in Markpion display the same way in GitHub READMEs, issues and wikis, apart from the extensions noted below.

Supported GFM features ​

FeatureSyntaxNotes
Tables| a | b |With column alignment. See Tables
Task lists- [ ] / - [x]Clickable in the preview; Ctrl+Enter toggles them in the editor
Strikethrough~~text~~Ctrl+Shift+X
Autolinkshttps://example.com, www.example.comBare URLs and email addresses become links
Fenced code blocks``` or ~~~, with a languageSyntax highlighting. See Code blocks
Footnotestext[^1] and [^1]: noteSee Footnotes
Alerts> [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION]See Alerts
Heading anchors[link](#heading-text)The same anchor ids as GitHub
HTML<details>, <kbd> and similarSanitized with GitHub's allow-list
Emoji shortcodes:tada:, :white_check_mark:GitHub's names. Shortcodes in code stay as typed. PDF export keeps the shortcode text, because its font has no emoji

Extensions beyond GFM ​

Markpion also supports, and GitHub renders too:

And, unlike GitHub, wiki links such as [[Setup Guide]] and tags such as #draft.

Differences from GitHub ​

  • Mentions and issue references such as @user and #123 stay plain text, because they only mean something inside a GitHub repository.
  • HTML follows the same allow-list idea as GitHub, but the exact list of allowed attributes can differ slightly.