Markdown Cheatsheet and Reference
Disclaimer: This blog post serves as a testing ground for markdown syntax functionalities available on GitHub Pages. Since GitHub Pages utilise markdown for text rendering, not all functionalities and add-ons might be supported. The content within this post, consisting of “Lorem Ipsum” text, is solely for testing purposes. Please disregard the actual writing itself.
[!NOTE] Essential details that users should not overlook, even when browsing quickly.
[!TIP] Additional advice to aid users in achieving better outcomes.
[!IMPORTANT] Vital information required for users to attain success.
[!WARNING] Urgent content that requires immediate user focus due to possible risks.
[!CAUTION] Possible negative outcomes resulting from an action.
Table of contents:
- Formatting
- Footnoes
- Tables
- Embadded code in the aritcle
- Diagrams & Charts
- Mathematical expressions
- Embadded youtube vidoes
- Final thoughts
Formatting
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.~~
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.
Footnoes
Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
You can also use words, to fit your writing style more closely[^note].
[^1]: My reference.
[^2]: Every new line should be prefixed with 2 spaces.
This allows you to have a footnote with multiple lines.
[^note]:
Named footnotes will still render with numbers instead of the text but allow easier identification and linking.
This footnote also has been made with a different syntax using 4 spaces for new lines.
Here is a simple footnote1.
A footnote can also have multiple lines2.
You can also use words, to fit your writing style more closely[^note].
This allows you to have a footnote with multiple lines.
[^note]:
Named footnotes will still render with numbers instead of the text but allow easier identification and linking.
This footnote also has been made with a different syntax using 4 spaces for new lines.
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
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 |
Embadded code in the aritcle
SELECT *
FROM sys.tables
WHERE [name] = 'SomeTable'
1..300 | oh -Paging
1..300 | more
Diagrams & Charts
pie
"Movies" : 80
"TV shows" : 20
pie
"Movies" : 80
"TV shows" : 20
Mathematical expressions
This is an inline math expression $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
This is an inline math expression $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}
Embadded youtube vidoes
[](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
Final thoughts
There are still a lot of tips and tricks on markdowns to learn out there.