Markdown Syntax Guide

Markdown Syntax Support

While most markdown features are supported out of the box, TinaCMS will ignore elements that it cannot handle. We do not expect to support the full CommonMark and GitHub Flavored Markdown specs. Be sure to voice your support for various rich-text features by reaching out through one of our community channels!

Supported Elements

Here’s an overview of Markdown syntax with examples that you can use with TinaCMS or in your own text files.

Headers

Emphasis

This text will be italic

This text will be bold

You can combine them

~~This text has a strikethrough~~

Lists

Unordered

Item 1
Item 2
- Item 2a
- Item 2b

Ordered

Item 1
Item 2
Item 3
1. Item 3a
2. Item 3b

Images

Links

https://tina.io - automatic! TinaCMS

Blockquotes

As Napoleon said about the liger:

It’s pretty much my favorite animal. It’s like a lion and a tiger mixed… bred for its skills in magic.

Inline code

I think you should use an <addr> element here instead.

Syntax highlighting

Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:

And here's how it looks - nicely colored with styled code titles!

Tables

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

Diagrams

You can use Mermaid diagrams to visualize flows, sequences, and other chart types directly in Markdown. Here’s an example of a Mermaid flowchart:

Unsupported Elements

Footnotes
Code blocks via indentation (use ``` instead)
Code blocks in list items
Non-inline elements in tables...
Links with an unsupported scheme – only URLs beginning with http, https, mailto, tel and xref will be recognised.

Non-serializable content

TinaCMS has no build step when MDX is used.

This means that any JavaScript expressions needing execution won't take effect.

No support for import/export
No support for JavaScript expressions, such as...
- const a = 2
- ## Today is {new Date().toLocaleString()}