103 |
104 |
105 |
--------------------------------------------------------------------------------
/content/notes/markdown_here_cheatsheet.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Markdown Here Cheatsheet"
3 | date = 2020-03-20
4 | +++
5 |
6 | This is intended as a quick reference and showcase. For more complete info, see [John Gruber's original spec](http://daringfireball.net/projects/markdown/) and the [Github-flavored Markdown info page](http://github.github.com/github-flavored-markdown/).
7 |
8 | This cheatsheet is specifically *Markdown Here's* version of Github-flavored Markdown. This differs slightly in styling and syntax from what Github uses, so what you see below might vary a little from what you get in a *Markdown Here* email, but it should be pretty close.
9 |
10 | You can play around with Markdown on our [live demo page](http://www.markdown-here.com/livedemo.html).
11 |
12 | (If you're not a Markdown Here user, check out the [Markdown Cheatsheet](./Markdown-Cheatsheet) that is not specific to MDH. But, really, you should also use Markdown Here, because it's awesome. http://markdown-here.com)
13 |
14 | ##### Table of Contents
15 | [Headers](#headers)
16 | [Emphasis](#emphasis)
17 | [Lists](#lists)
18 | [Links](#links)
19 | [Images](#images)
20 | [Code and Syntax Highlighting](#code)
21 | [Tables](#tables)
22 | [Blockquotes](#blockquotes)
23 | [Inline HTML](#html)
24 | [Horizontal Rule](#hr)
25 | [Line Breaks](#lines)
26 | [YouTube Videos](#videos)
27 | [TeX Mathematical Formulae](#tex)
28 |
29 | ## Headers
30 |
31 | ```no-highlight
32 | # H1
33 | ## H2
34 | ### H3
35 | #### H4
36 | ##### H5
37 | ###### H6
38 |
39 | Alternatively, for H1 and H2, an underline-ish style:
40 |
41 | Alt-H1
42 | ======
43 |
44 | Alt-H2
45 | ------
46 | ```
47 |
48 | # H1
49 | ## H2
50 | ### H3
51 | #### H4
52 | ##### H5
53 | ###### H6
54 |
55 | Alternatively, for H1 and H2, an underline-ish style:
56 |
57 | Alt-H1
58 | ======
59 |
60 | Alt-H2
61 | ------
62 |
63 | ## Emphasis
64 |
65 | ```no-highlight
66 | Emphasis, aka italics, with *asterisks* or _underscores_.
67 |
68 | Strong emphasis, aka bold, with **asterisks** or __underscores__.
69 |
70 | Combined emphasis with **asterisks and _underscores_**.
71 |
72 | Strikethrough uses two tildes. ~~Scratch this.~~
73 | ```
74 |
75 | Emphasis, aka italics, with *asterisks* or _underscores_.
76 |
77 | Strong emphasis, aka bold, with **asterisks** or __underscores__.
78 |
79 | Combined emphasis with **asterisks and _underscores_**.
80 |
81 | Strikethrough uses two tildes. ~~Scratch this.~~
82 |
83 |
84 | ## Lists
85 |
86 | ```no-highlight
87 | 1. First ordered list item
88 | 2. Another item
89 | * Unordered sub-list.
90 | 1. Actual numbers don't matter, just that it's a number
91 | 1. Ordered sub-list
92 | 4. And another item.
93 |
94 | Some text that should be aligned with the above item.
95 |
96 | * Unordered list can use asterisks
97 | - Or minuses
98 | + Or pluses
99 | ```
100 |
101 | 1. First ordered list item
102 | 2. Another item
103 | * Unordered sub-list.
104 | 1. Actual numbers don't matter, just that it's a number
105 | 1. Ordered sub-list
106 | 4. And another item.
107 |
108 | Some text that should be aligned with the above item.
109 |
110 | * Unordered list can use asterisks
111 | - Or minuses
112 | + Or pluses
113 |
114 | ## Links
115 |
116 | There are two ways to create links.
117 |
118 | ```no-highlight
119 | [I'm an inline-style link](https://www.google.com)
120 |
121 | [I'm a reference-style link][Arbitrary case-insensitive reference text]
122 |
123 | [You can use numbers for reference-style link definitions][1]
124 |
125 | Or leave it empty and use the [link text itself]
126 |
127 | URLs and URLs in angle brackets will automatically get turned into links.
128 | http://www.example.com or and sometimes
129 | example.com (but not on Github, for example).
130 |
131 | Some text to show that the reference links can follow later.
132 |
133 | [arbitrary case-insensitive reference text]: https://www.mozilla.org
134 | [1]: http://slashdot.org
135 | [link text itself]: http://www.reddit.com
136 | ```
137 |
138 | [I'm an inline-style link](https://www.google.com)
139 |
140 | [I'm a reference-style link][Arbitrary case-insensitive reference text]
141 |
142 | [You can use numbers for reference-style link definitions][1]
143 |
144 | Or leave it empty and use the [link text itself]
145 |
146 | URLs and URLs in angle brackets will automatically get turned into links.
147 | http://www.example.com or and sometimes
148 | example.com (but not on Github, for example).
149 |
150 | Some text to show that the reference links can follow later.
151 |
152 | [arbitrary case-insensitive reference text]: https://www.mozilla.org
153 | [1]: http://slashdot.org
154 | [link text itself]: http://www.reddit.com
155 |
156 | ## Images
157 |
158 | ```no-highlight
159 | Here's our logo (hover to see the title text):
160 |
161 | Inline-style:
162 | 
163 |
164 | Reference-style:
165 | ![alt text][logo]
166 |
167 | [logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
168 | ```
169 |
170 | Here's our logo (hover to see the title text):
171 |
172 | Inline-style:
173 | 
174 |
175 | Reference-style:
176 | ![alt text][logo]
177 |
178 | [logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 2"
179 |
180 | ## Code and Syntax Highlighting
181 |
182 | Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and *Markdown Here* -- support syntax highlighting. *Markdown Here* supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the [highlight.js demo page](http://softwaremaniacs.org/media/soft/highlight/test.html).
183 |
184 | ```no-highlight
185 | Inline `code` has `back-ticks around` it.
186 | ```
187 |
188 | Inline `code` has `back-ticks around` it.
189 |
190 | Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.
191 |
192 |
```javascript
193 | var s = "JavaScript syntax highlighting";
194 | alert(s);
195 | ```
196 |
197 | ```python
198 | s = "Python syntax highlighting"
199 | print s
200 | ```
201 |
202 | ```
203 | No language indicated, so no syntax highlighting.
204 | But let's throw in a <b>tag</b>.
205 | ```
206 |
207 |
208 |
209 |
210 | ```javascript
211 | var s = "JavaScript syntax highlighting";
212 | alert(s);
213 | ```
214 |
215 | ```python
216 | s = "Python syntax highlighting"
217 | print s
218 | ```
219 |
220 | ```
221 | No language indicated, so no syntax highlighting in Markdown Here (varies on Github).
222 | But let's throw in a tag.
223 | ```
224 |
225 | Again, to see what languages are available for highlighting, and how to write those language names, see the [highlight.js demo page](http://softwaremaniacs.org/media/soft/highlight/test.html).
226 |
227 | ## Tables
228 |
229 | Tables aren't part of the core Markdown spec, but they are part of GFM and *Markdown Here* supports them. They are an easy way of adding tables to your email -- a task that would otherwise require copy-pasting from another application.
230 |
231 | ```no-highlight
232 | Colons can be used to align columns.
233 |
234 | | Tables | Are | Cool |
235 | | ------------- |:-------------:| -----:|
236 | | col 3 is | right-aligned | $1600 |
237 | | col 2 is | centered | $12 |
238 | | zebra stripes | are neat | $1 |
239 |
240 | The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
241 |
242 | Markdown | Less | Pretty
243 | --- | --- | ---
244 | *Still* | `renders` | **nicely**
245 | 1 | 2 | 3
246 | ```
247 |
248 | Colons can be used to align columns.
249 |
250 | | Tables | Are | Cool |
251 | | ------------- |:-------------:| -----:|
252 | | col 3 is | right-aligned | $1600 |
253 | | col 2 is | centered | $12 |
254 | | zebra stripes | are neat | $1 |
255 |
256 | The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
257 |
258 | Markdown | Less | Pretty
259 | --- | --- | ---
260 | *Still* | `renders` | **nicely**
261 | 1 | 2 | 3
262 |
263 | ## Blockquotes
264 |
265 | ```no-highlight
266 | > Blockquotes are very handy in email to emulate reply text.
267 | > This line is part of the same quote.
268 |
269 | Quote break.
270 |
271 | > This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
272 | ```
273 |
274 | > Blockquotes are very handy in email to emulate reply text.
275 | > This line is part of the same quote.
276 |
277 | Quote break.
278 |
279 | > This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
280 |
281 | ## Inline HTML
282 |
283 | You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
284 |
285 | ```no-highlight
286 |
287 |
Definition list
288 |
Is something people use sometimes.
289 |
290 |
Markdown in HTML
291 |
Does *not* work **very** well. Use HTML tags.
292 |
293 | ```
294 |
295 |
296 |
Definition list
297 |
Is something people use sometimes.
298 |
299 |
Markdown in HTML
300 |
Does *not* work **very** well. Use HTML tags.
301 |
302 |
303 | ## Horizontal Rule
304 |
305 | ```
306 | Three or more...
307 |
308 | ---
309 |
310 | Hyphens
311 |
312 | ***
313 |
314 | Asterisks
315 |
316 | ___
317 |
318 | Underscores
319 | ```
320 |
321 | Three or more...
322 |
323 | ---
324 |
325 | Hyphens
326 |
327 | ***
328 |
329 | Asterisks
330 |
331 | ___
332 |
333 | Underscores
334 |
335 | ## Line Breaks
336 |
337 | My basic recommendation for learning 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), see what happens. You'll soon learn to get what you want. "Markdown Toggle" is your friend.
338 |
339 | Here are some things to try out:
340 |
341 | ```
342 | Here's a line for us to start with.
343 |
344 | This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
345 |
346 | This line is also a separate paragraph, but...
347 | This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
348 | ```
349 |
350 | Here's a line for us to start with.
351 |
352 | This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
353 |
354 | This line is also begins a separate paragraph, but...
355 | This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
356 |
357 | (Technical note: *Markdown Here* uses GFM line breaks, so there's no need to use MD's two-space line breaks.)
358 |
359 | ## YouTube Videos
360 |
361 | They can't be added directly but you can add an image with a link to the video like this:
362 |
363 | ```no-highlight
364 |
367 | ```
368 |
369 | Or, in pure Markdown, but losing the image sizing and border:
370 |
371 | ```no-highlight
372 | [](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
373 | ```
374 |
375 | ## TeX Mathematical Formulae
376 |
377 | A full description of TeX math symbols is beyond the scope of this cheatsheet. Here's a [good reference](https://en.wikibooks.org/wiki/LaTeX/Mathematics), and you can try stuff out on [CodeCogs](https://www.codecogs.com/latex/eqneditor.php). You can also play with formulae in the Markdown Here options page.
378 |
379 | Here are some examples to try out:
380 |
381 | ```
382 | $-b \pm \sqrt{b^2 - 4ac} \over 2a$
383 | $x = a_0 + \frac{1}{a_1 + \frac{1}{a_2 + \frac{1}{a_3 + a_4}}}$
384 | $\forall x \in X, \quad \exists y \leq \epsilon$
385 | ```
386 |
387 | The beginning and ending dollar signs (`$`) are the delimiters for the TeX markup.
388 |
--------------------------------------------------------------------------------
