Markdown Guide
You can write content using GitHub-flavored Markdown syntax.
#
Markdown SyntaxTo serve as an example page when styling markdown based Docusaurus sites.
#
Headers#
H1 - Create the best documentation#
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#
EmphasisEmphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with double asterisks or double underscores.
Combined emphasis with asterisks and underscores.
#
TablesColons can be used to align columns.
Code:
Result:
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.
Code:
Result:
| Markdown | Less | Pretty |
| -------- | --------- | ---------- |
| Still | renders
| nicely |
| 1 | 2 | 3 |
#
BlockquotesBlockquotes 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
- Does *not* work **very** well. Use HTML tags.
#
Line BreaksHere'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.
#
Admonitionsnote
This is a note
tip
This is a tip
important
This is important
caution
This is a caution
warning
This is a warning