Mental Pivot

Notes and observations from a lifelong pursuit of learning.

 
Insights and interesting reads delivered straight to your inbox.
Sign up for the free Mental Pivot Newsletter.

An Overview of Markdown Support in Ghost CMS

The goal of this article is to provide you with an overview of which Markdown features are available in the Ghost Editor and which features are available in the Markdown cards.

I've been making increasing use of Markdown while using the Ghost CMS. Unfortunately, the more I used the Ghost Editor, the more I realized that support for certain Markdown elements was spotty. Some elements are supported directly via the Ghost Editor while others are not. Further complicating the issue is that some Markdown features are supported in Ghost's Markdown cards. Last week's article on nested lists illustrates one specific example that prompted this followup post.

According to the Ghost team, Ghost uses the CommonMark spec. CommonMark is an effort to standardize and build upon the original Markdown spec (the latter hasn't been updated since 2004). Given this fact, it is reasonable to expect that Ghost should support the features defined in the CommonMark spec.

The reference table below is simply a catalog, based on my personal usage and testing, of which Markdown features works in the Ghost Editor and which features work in Ghost's Markdown cards as of Ghost version 3.11. Note that in many cases there are other workarounds or implementations available via Ghost. I am only considering the availability Markdown-specific features below (e.g. use of Markdown syntax/tags in order to achieve a specific output).

For references detailing actual Markdown usage, check out Ghost.org's Markdown FAQ or the Markdown Guide.


Feel free to contact me and let me know if I've made any errors or omissions.


Block Level Elements

Markdown Element Ghost Editor
Support?
Markdown Card
Support?
Headings
Paragraphs
Line Breaks
Lists (Unordered/Ordered)
  Nested/Indented Lists
Block Quotes
  Nested/Indented Block Quotes
Code: Inline
Code: Block
Horizontal Rule

Highlighting Text

Markdown Element Ghost Editor
Support?
Markdown Card
Support?
Bold
Italic
Highlight
Strikethrough
Supertext
Subtext
Markdown Element Ghost Editor
Support?
Markdown Card
Support?
Auto-Linked URLs
Inline Links
  Link Titles
  Reference Links
Images
  Linked Images
  Reference Links

Advanced Features

Markdown Element Ghost Editor
Support?
Markdown Card
Support?
Footnotes [1]
Inline HTML
  HTML Character Entities
Tables
  Column Alignment

  1. Note that footnote support is only for references that are fully contained within a single Markdown card. One alternative solution is to create footnotes manually. ↩︎


One last minor difference noticed between the Ghost Editor and Ghost's Markdown Cards is that multiple whitespace between individual characters or words are preserved in the Ghost Editor but not in a Markdown Card. For instance, if you add four spaces between two words, the Ghost Editor will honor the whitespace whereas the Markdown Card will render a single space between the two words.



Get weekly email updates and additional content: Sign up for the free Mental Pivot Newsletter.