Thank you to FelesNoctis for compiling this list! If you found this useful, please give them kudos.
¶ Supported Formatting
¶ Paragraphs and Linebreaks
A single line break will connect the two lines as sentences, which obviously isn't very useful.
A "hard break" can be created by adding two spaces ( )
and the end of a line before a single line break. You can also use a backslash (\)
which is easier to see.
Two or more line breaks (seen all through this section) make an entirely new paragraph.
The ⠀ "braille blank" whitespace character character is no longer necessary to create paragraphs, but you can still use it for creating extra space.
A single line break will connect the
two lines as sentences,
which obviously isn't very
useful.
A "hard break" can be created by adding two spaces (` `)
and the end of a line before a single line break. You can also use a backslash (`\`)\
which is easier to see.
Two or more line breaks (seen all through this section) make an entirely new paragraph.
The `⠀` "braille blank" whitespace character character is no longer necessary to create paragraphs, but you can still use it for creating extra space.
¶ Heading Tags
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
¶ Text Styling
Asterisks for: *Italic*, **Bold**, ***Both***
¶ Links
Basic link: https://www.nexusmods.com/site/mods/1
Named link: Vortex
Hover link: Vortex
Basic link: <https://www.nexusmods.com/site/mods/1>
Named link: [Vortex](https://www.nexusmods.com/site/mods/1)
Hover link: [Vortex](https://www.nexusmods.com/site/mods/1 "Vortex page")
¶ Link Reference
There is also a more advanced method called a "Link Reference". These allow you to place a link somewhere with a defined URL elsewhere on the page. For instance, the first link below has its URL definition in-between the two italicized lines, while the second's URL is actually above this paragraph! References will always use the first instance of their definition found on the page.
Named Link: Vortex
Hover Link: Google Homepage
(Filler text to show separation of reference and defined URL)
(More text below the defined URL)
### Link Reference
[sneakygoogle]: https://www.google.com "You know where this goes."
There is also a more advanced method called a "Link Reference". These allow you to...
Named Link: [Vortex][vortexapp]
Hover Link: [Google Homepage][sneakygoogle]
(*Filler text to show separation of reference and defined URL*)
[vortexapp]: https://www.nexusmods.com/site/mods/1
(*More text below the defined URL*)
¶ Images
Basic Image:
Linked Image + Hover text:
Linked Referenced Image + Referenced Link + Hover Text:
Basic Image:
Linked Image + Hover text:
[](https://www.nexusmods.com/site/mods/1 "Vortex page")
[vorteximage]: https://i.imgur.com/xXhkzvj.png
Linked Referenced Image + Referenced Link + Hover Text:
[vorteximagelink]: https://www.nexusmods.com/site/mods/1 "Vortex page"
[vorteximage]: https://i.imgur.com/xXhkzvj.png
[![Vortex][vorteximage]][vorteximagelink]
¶ Videos
To add a video, use the insert button on the editor toolbar or simply paste the YouTube link directly on a new line. Examples of the supported URL formats are shown below.
https://www.youtube.com/watch?v=RqGYlWjJxi4
https://m.youtube.com/watch?v=RqGYlWjJxi4
https://www.youtube.com/v/RqGYlWjJxi4
https://www.youtube.com/embed/RqGYlWjJxi4
https://www.youtube-nocookie.com/embed/RqGYlWjJxi4
https://youtu.be/RqGYlWjJxi4
https://www.youtube.com/shorts/DFYRQ_zQ-gk
¶ Horizontal Rule
A horizontal rule (what you see between each section) can be created using 3 underscores ( ___ ), dashes ( --- ), or asterisks ( *** ). Horizontal rule best practices are typically to put a line break before and after your rule, as shown here:
[Section 1 content]
___
[Section 2 content]
¶ Blockquotes
Blockquote
Double Blockquote
Triple Blockquote
Blockquote after double linebreak
Stacked Blockquote after double linebreak
> Blockquote
>> Double Blockquote
>>> Triple Blockquote
> Blockquote after double linebreak
>>> Stacked Blockquote after double linebreak
¶ Unordered Lists
⠀
- Unordered List item
- Unordered List item
- Unordered List item
- Unordered List item in blockquote
- Unordered List item in stacked blockquote
- First item
- Second item
- Third item
- Indented item
- Indented item
- Fourth item
- Unordered List item
- Unordered List item
- Unordered List item
> - Unordered List item in blockquote
>> - Unordered List item in stacked blockquote
- First item
- Second item
- Third item
- Indented item
- Indented item
- Fourth item
¶ Ordered Lists
- Ordered List item
- Ordered List item
- Ordered List item
- Ordered List item in blockquote
- Ordered List item in blockquote
- Ordered List item in stacked blockquote
- Ordered List item in stacked blockquote
- First item
- Second item
- Third item
- First indented item
- Second indented item
- Fourth item
1. Ordered List item
2. Ordered List item
3. Ordered List item
> 5. Ordered List item in blockquote
> 6. Ordered List item in blockquote
>> 9. Ordered List item in stacked blockquote
>> 10. Ordered List item in stacked blockquote
1. First item
2. Second item
3. Third item
1. First indented item
2. Second indented item
4. Fourth item
¶ Quirks
- Note in the provided examples that the numbers don't always have to be in exact numerical order. Usually, as long as a number, period, and space are in that exact sequence (
5.) are near the beginning of the line (at the start or after other certain formatting codes), they will be formatted as an ordered list. - Later numbers in a set DO need to be sequentially one higher than the previous in the same list however, otherwise you'll experience odd glitches (see Not Implemented/Broken below). - The exception to both quirks above is when you're indenting an ordered list, you have to start it with
1., otherwise content will appear on the same line as the previous parent list item (see Not Implemented/Broken below).
¶ Paragraph Item in a List
-
First list item
-
Second list item
A paragraph for the second list item.
-
Third list item
-
First list item
-
Second list item
A paragraph for the second list item.
-
Third list item.
- First list item
- Second list item
A paragraph for the second list item.
- Third list item
1. First list item
2. Second list item
A paragraph for the second list item.
3. Third list item
¶ Inline Code Snippet
Make code snips in a sentence via the backtick character ( ` ) at each end of what you want snipped.
Note that they accept external formatting, but not *internal* formatting.
Make `code snips` in a `sentence` via the backtick character ( ` ) at each end of what you want snipped.
Note *that `they` accept* external formatting, but not `*internal*` formatting.
¶ Code Blocks
Code Blocks come in two forms: Fenced and Indented. Fenced is generally the preferred method as it's easier to control. Fenced are made by surrounding the text with three backticks at each end ( ``` ), while Indented can be made by prefixing each line with four spaces ( ).
Code Blocks will always respect
all whitespace and line breaks
but do not accept *any* **kind** `of`
> internal formatting
¶ Escape Formatting
You can also escape pretty much anything using a backslash (\), which was used in the code snip and block examples.
**bold** and *italics*
\*\*bold\*\* and \*italics\*
\<http://www.example.com>
`code snip`
\`code snip\`
¶ Unsupported Formatting
¶ Raw HTML
<pre>All HTML processing is disabled.</pre>
<pre>All HTML processing is disabled.</pre>
¶ Strikethrough
~~Much broke, very wow~~
~~Much broke, very wow~~
¶ URL Auto-Link
http://www.example.com
¶ Header IDs
##### An ID'd Header
[Link To headerID](#headerID)
##### An ID'd Header {#headerID}
[Link To headerID](#headerID)
¶ Improper Numerical Order
for Ordered Lists
- Item "1"
- Item "3"
- Item "2"
- Item "5" in blockquote
- Item "8" in blockquote
- Item "12" in stacked blockquote
- Item "9" item in stacked blockquote
1. Item "1"
3. Item "3"
2. Item "2"
> 5. Item "5" in blockquote
> 8. Item "8" in blockquote
>> 12. Item "12" in stacked blockquote
>> 9. Item "9" item in stacked blockquote
¶ Improper Numerical Start
for Indented Ordered Lists
- Item "1"
- Item "2"
- Item "3"
2. Indented item "2"
3. Indented item "3"- Indented item "1"
- Item "5"
1. Item "1"
2. Item "2"
3. Item "3"
2. Indented item "2"
3. Indented item "3"
1. Indented item "1"
5. Item "5"
¶ Task Lists
- [x] Task 1
- [ ] Task 2
- [ ] Task 3
- [x] Task 1
- [ ] Task 2
- [ ] Task 3
¶ Tables
| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |
¶ Code Block Syntax Highlighting
Declared syntax is "json".
{
"jsonString1": "One",
"jsonString2": "Two",
"jsonInteger": 3
}
¶ Definitions
First Term : First term first definition.
Second Term : Second term first definition. : Second term second definition.
First Term
: First term first definition.
Second Term
: Second term first definition.
: Second term second definition.
¶ Footnotes
(directly from markdownguide.org)
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.
Indent paragraphs to include them in the footnote.
`{ my code }`
Add as many paragraphs as you like.