This project uses Markdown for formatting text. I’ve embedded the Markdown Cheat Sheet below, so you can see how it’s styled, and what features are supported.

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.

Basic Syntax

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Heading

H1

H2

H3

Bold

Here’s some bold text in a sentence.

Italic

How about some italicized text?

Bold & Italic

If you really want to emphasize something, try bold and italic text.

Blockquote

Ordered List

1. First item
2. Second item
3. Third item

Unordered List

• First item
• Second item
• Third item

Code

And here’s some inline code surrounded with ordinary text.

Horizontal Rule

Link

Markdown Guide

Image

Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Footnote

Here’s a sentence with a footnote. ¹

Definition List

term : definition

Strikethrough

I didn’t mean to say this.

Task List

• Write the press release
• Update the website
• Contact the media

Heading ID — ❌ unsupported

Curly braces in MDX escape to JavaScript, so they can’t be used to assign ids.

md
### My Great Heading {#custom-id}

md
### My Great Heading {#custom-id}

Use JSX instead

jsx
<h1 id="custom-id">My Great Heading</h1>

jsx
<h1 id="custom-id">My Great Heading</h1>

Emoji — ❌ unsupported

That is so funny! :joy:

That is so funny! :joy:

Use your system emoji picker instead.

Highlight — ❌ unsupported

I need to highlight these ==very important words==.

Subscript

H2O

Superscript

X²