Eggmarkdown Cheatsheet
This document is intended as a quick reference — if you want more information...
- in a written form, see the full Eggmarkdown syntax guide
- in a video form, see the Eggmarkdown explainer video
Headers
# H1
## H2
### H3
#### H4
##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
H1 Alternative
===
H2 Alternative
---
TODO: add eggmarkdown rendering in separate tab
Emphasis (Bold, Italic, Combined, and Strikethrough)
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.~~
TODO: add eggmarkdown rendering in separate tab
Lists
(In this example, leading and trailing spaces are shown with with dots: ⋅)
1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
⋅⋅1. Ordered sub-list
4. And another item.
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
* Unordered list can use asterisks
- Or minuses
+ Or pluses
TODO: add eggmarkdown rendering in separate tab
Links and Buttons
There are two ways to create links.
[I'm an inline-style link](https://www.google.com)
[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a relative reference to a repository file](../blob/master/LICENSE)
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].
URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or <http://www.example.com> and sometimes
example.com (but not on Github, for example).
Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
Creating a button is similar, but different.
@[I'm a button](https://www.example.com)
TODO: add eggmarkdown rendering in separate tabs
Images
For a regular, inline image:
Here's a Joshua Tree (hover to see the title text):
Inline-style:
Reference-style:
![alt text][joshua]
[joshua]: https://static.eggmail.email/local/868058973/819986112/2M1AcCWnSh8BCMDadsBncl9nb2N.jpg "Title Text 2"
For a hero image:
Here's a Joshua Tree (hover to see the title text):
Inline-style:
^[alt text](https://static.eggmail.email/local/868058973/819986112/2M1AcCWnSh8BCMDadsBncl9nb2N.jpg "Title Text 1")
Reference-style:
^[alt text][joshua]
[joshua]: https://static.eggmail.email/local/868058973/819986112/2M1AcCWnSh8BCMDadsBncl9nb2N.jpg "Title Text 2"
TODO: add eggmarkdown rendering in separate tabs
Code and Syntax Highlighting
Inline `code` has `backticks around` it.
TODO: add eggmarkdown rendering in separate tab or below
Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces.
We recommend using the fenced code blocks — they're easier to use, and only fenced code blocks
support syntax highlighting.
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
TODO: add eggmarkdown rendering in separate tab or below
Blockquotes
> Blockquotes can be useful.
> 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. You can *put* **Markdown** into a blockquote. Let's be really really really really really really really really long.
TODO: add eggmarkdown rendering in separate tab or below
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
TODO: add eggmarkdown rendering in separate tab or below
Divider (Horizontal Rule)
Three or more...
---
Hyphens
***
Asterisks
___
Underscores
TODO: add eggmarkdown rendering in separate tab or below
Newlines
The easiest way to learn how line breaks work is to experiment and discover -- hit Enter once (i.e., insert one newline),
then hit it twice (i.e., insert two newlines), and see what happens.
Here are some things to try out:
Here'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*.
Sections
These are interpreted by templates as separate sections, and may get extra styling. Syntax is similar to code fencing.
$$$
I'm a section.
$$$
TODO: add eggmarkdown rendering in separate tab or below
Columns
These will always work, but must live inside a section. Syntax is similar to code fencing.
$$$
I'm a section.
^^^
Column 1
^^^
^^^
Column 2 I'm longer! Really really really really really really really really really really really really really long
^^^
^^^
Column 3
^^^
$$$
TODO: add eggmarkdown rendering in separate tab or below
Inline HTML
You can also use raw HTML in your Markdown, and it will mostly work (we just scrub it for things that email clients will interpret as security risks).