Cheatsheet for markdown

Oct. 23, 2024

Introduction

Don’t take this cheat sheet serious. It’s created just for the purpose of maintaining this website. Since hugo relies on markdown files, I just created one big markdown file that contains all elements I need. For my own convenience. If you like it, good. If you don’t, also good.
Now lets start with a footnote1.

Footnote syntax

Define by adding [^1] behind the word where you want the '1' added.
Then on the last row of your page add the note itself:
[^1]: Footnote text. 

Here is another2 one.

Introducing headers

Header two

Header three

# Introducing headers
## Header two
### Header three

Space does enter.

Adding two spaces to the end of a line adds a <br> so that we create CR/LF.
This comes in handy sometimes. (otherwise it would have added this line next to the . of the previous line).

Blockquote example

The quarterly results look great! (with four #)

  • Revenue was off the chart.
  • Profits were higher than ever.

Everything is going according to plan.

Accent grave

The accent grave (on the ~ key) can be used once for highlighted text, or it can be used three times to indicate the start and end of a code block, as seen below:

bold text - italic text

 **bold text**
 *italic text* 

List (ordered)

  1. this is an ordered list (simply state 1. xxx)
  2. this is another item

List (unordered)

Links and images

[link to google](http://www.google.com)
[link to google](http://www.google.com "Not the best engine but it will do")
![alt text](image.jpg)

link to google
link to google alt text

A few other things that can be done

Tilde will strikethrough everything.

term
definition
Tilde will ~strike~through everything.  

- [x] task List
- [ ] done

term
: definition

Introducing tables

Syntax Description test
Header Title stuff
Para Text Blah
| Syntax | Description | test  |
| ------ | ----------- | ----  |
| Header | Title       | stuff |
| Para   | Text        | Blah  |

Ruler

To add a rule, use - - - (without spaces) between two empty lines.


This will add a horizontal ruler as seen above.

Special characters

This is the € sign.
This is the © sign.
This is the → sign.
This is the ™ sign.
This is the π sign.
This is the ° sign.

This is the &euro; sign.  
This is the &copy; sign.  
This is the &rarr; sign.  
This is the &trade; sign.  
This is the &#960; sign.  
This is the &#176; sign.

Add iFrames of other sites

There’s a thing called Hugo Shortcodes that can be used to easily embed parts of other websites, such as youtube videos, music, and the likes. A full explanation can be found here.

(remove first space to make this work:)
{ {< twitter user="SanDiegoZoo" id="1453110110599868418" >}}
{ {< youtube w7Ft2ymGmfc >}}
{ {< instagram CxOWiQNP2MO >}}

  1. Here’s the footnote mentioned above. ↩︎

  2. Just showing off. ↩︎