Markdown Features

Markdown is the same thing that allows you to style text in Slack, GitHub READMEs, and much more. Here we will see the Markdown features you can use in your docs. It can be helpful to look at other docs' .md / .mdx files to get ideas for how to author your own.

Standard Markdown

All of the articles in this repository use Markdown and MDX. You can write content using GitHub Flavored Markdown syntax; Docusaurus also supports its own Markdown features.

Headers

H2 - Create the best documentation

H3 - Create the best documentation

H4 - Create the best documentation

H5 - Create the best documentation

H6 - Create the best documentation

tip

Don't use # (H1) in a doc — the page's title frontmatter is already rendered as the H1.

---

Emphasis

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

---

Lists

1. First ordered list item
2. Another item
   • Unordered sub-list.
3. Actual numbers don't matter, just that it's a number
   1. Ordered sub-list
4. And another item.

• Unordered list can use asterisks

• Or minuses

• Or pluses

---

Links

I'm an inline-style link

I'm an inline-style link with title

I'm a reference-style link

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or http://www.example.com/ and sometimes example.com (but not on GitHub, for example).

Some text to show that the reference links can follow later.

---

Images

Inline-style:

Reference-style:

Images placed in static/img/ are served at /img/…. You can also reference images with a path relative to your Markdown file if they live alongside the doc.

---

Code

var s = "JavaScript syntax highlighting";
alert(s);

s = "Python syntax highlighting"
print(s)

No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.

function highlightMe() {
  console.log("This line can be highlighted!");
}

---

Tables

Colons can be used to align columns.

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.

Markdown	Less	Pretty
Still	renders	nicely
1	2	3

---

Blockquotes

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.

---

Inline HTML

Definition list

Is something people use sometimes.

Markdown in HTML

Works fine inside .mdx files. In plain .md, prefer HTML tags.

---

Line Breaks

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.

---

Admonitions

note

This is a note

tip

This is a tip

info

This is info

important

This is important

warning

This is a warning

danger

This is a danger callout — reserved for critical issues

If you want to get more advanced, you can use MDX

info

MDX syntax can be boiled down to being JSX in Markdown. It's a superset of Markdown syntax that also supports importing, exporting, and JSX. If you're planning to use MDX to author your content, be sure to use the .mdx file extension when naming your file.

Getting started with MDX.