Skip to content

Markdown🔗

Markdown is a way of writing plain text with ~style~. This Blog is made by converting Markdown files (.md) to HTML content (with a bit of React sparkle)

Organization and emphasis increase readability, and the format is widely accepted.

It's the Rich Text Markup of choice for Github README files. Examples here include 'Github Flavored Markdown' where noted.

Similar in principal, but much less daunting than Org Mode

Headers🔗

Output:🔗

Header 1🔗

Header 2🔗

Header 3🔗

Header 6🔗

Input:🔗

Markdown
1
2
3
4
# Header 1
## Header 2
### Header 3
###### Header 6

Line Break🔗

Output:🔗

Input🔗

Markdown
1
---

Code🔗

Fenced (Github Flavored Markdown)🔗

Output:🔗

Python
1
2
3
def do_the_things(stuff: [str]):
    for x in stuff:
        print(x)

Input:🔗

Text Only
1
2
3
4
5
```python
def do_the_things(stuff: [str]):
    for x in stuff:
        print(x)
```

Inline (Generic Markdown)🔗

Output:🔗

do_the_things(['one', 'two', 'three'])

Input:🔗

Markdown
1
`do_the_things(['one', 'two', 'three'])`

Bold and Italics🔗

Output:🔗

Italic Text

Bold Text

~~Striked-Through Text~~

Italic And Bold Text

Bold And Italic Text

Input:🔗

Markdown
1
2
3
4
5
6
7
8
9
*Italic Text* or _Italic Text_

**Bold Text** or __Bold Text__

~~Striked-Through Text~~

_Italic **And Bold** Text_

__Bold *And Italic* Text__

Quotes🔗

Output:🔗

As Abraham Lincoln said:

Don't believe what you read on the internet. That stuff can be dangerous.

Input:🔗

Markdown
1
2
3
4
As Abraham Lincoln said:

> Don't believe what you read on the internet.
> That stuff can be dangerous.

Lists🔗

Output:🔗

Ordered

  1. First Order
  2. Second Ordered
  3. Still Ordered

Unordered

  • Unordered Item
  • Another Item
  • A third Item

Input:🔗

NOTE: Can use just "1." or incrementing numbers, or one "1." then "-"

Markdown
1
2
3
4
5
6
7
8
9
1. First Order
1. Second Ordered
1. Still Ordered

Unordered

- Unordered Item
- Another Item
- A third Item

Links🔗

Output:🔗

Displayed Text As Link to /markdown

Input:🔗

Markdown
1
[Displayed Text As Link to /markdown](/markdown)

Tables (Github Flavored Only)🔗

Output:🔗

Column Name Other Column ID
Text omgwtfbbq 1
Number 1234 2

Input:🔗

Markdown
1
2
3
4
| Column Name | Other Column | ID |
| ------------|--------------|--- |
| Text        | omgwtfbbq    | 1 |
| Number      | 1234         | 2 |
Last update: June 7, 2023
Created: June 7, 2023