Markdown Overview
It's no surprise... Markdown is my favorite ever! It translates really well into how I want to *write* out of the box.
It powers Stack Overflow, Github, and a good chunk of the internet, while offering a delicate balance between robust expressiveness in typography, human readability on all platforms, and amazingly simple full text search.
If you're just getting started there are a couple symbols to remember that will help translate text into TEXT! There are plenty of online guides already detailing various flavors, but here's a brief overview contextualized into this site, including which elements are available and how they are displayed.
For some external quick reference guides, you can check out CommonMark or the original Markdown Syntax documentation by John Gruber
Syntax Guide #
Text #
*italics*
**bold**
~~muted~~
`inline-code`
italics
bold
muted
inline-code
Blockquote #
> Blockquote **bold**
Blockquote bold
Headers #
# h1 - Primary
## h2 - Secondary
### h3 - Tertiary
#### h4 - Quaternary
h1 - Primary
h2 - Secondary
h3 - Tertiary
h4 - Quaternary
Resources #
[link text](http://example.com/)
![img alt text](/assets//heart.svg)
Lists #
* un-ordered list
* eggs
* milk
- un-ordered list
- eggs
- milk
\1. ordered list
\2. home
\3. go to 2
- ordered list
- home
- go to 2
Horizontal Rule #
---
Tables #
| Name | Age | | ----- |:----:| | Frida | 10 | | Buddy | 12 | | Gus | 5 |
Name | Age |
---|---|
Frida | 10 |
Buddy | 12 |
Gus | 5 |
Syntax Highlighting #
For more info on supported languages, see syntax highlighting
```js
var pet = {
name: "Frida",
age: 13
}
```
var pet = {
name: "Frida",
age: 13
}
Extensions #
Definition List #
Term 1
~ Definition 1
Term 2
: Definition 2
- Term 1
- Definition 1
- Term 2
- Definition 2
File #
$$\\nessie\prog\Software\$$