This page for quick reference for all the markdown syntax I use on a day to day basis.

Setting up Table of Contents

Table of Contents

{ {% toc %} }

Headers

H1 - # H1

H2 - ## H2

H3 - ### H3

H4 - #### H4

H5 - ##### H5

H6 - ###### H6

To make a table

| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

Setting up Social Media, Shortcodes etc.

Youtube

{ {< youtube w7Ft2ymGmfc >} }

Note: Remove the space between the Curly brackets.

Twitter

Hugo 0.15 will have 30%+ faster render times thanks to this commit https://t.co/FfzhM8bNhT #gohugo #golang https://t.co/ITbMNU2BUf

— Steve Francia (@spf13) November 17, 2015

{ {< tweet 666616452582129664 >} }

Note: Remove the space between the Curly brackets.

Github Gist Shortcode

{ {< gist USERNAME GIST-ID  >} }

Note: Remove the space between the Curly brackets.

Emphasis

Italics with underscores.

Bold with asterisks.

Combined emphasis with asterisks and underscores.

Strikethrough with ~~two tildes~

Italics with _underscores_.

Bold with **asterisks**.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough with ~~two tildes~

Lists

Ordered

1. First item
2. Another item

1. First item
2. Another item

Unordered

• First item
• Another item

* First item
* Another item

Todo

• Write math example
• Write diagram example
• Do something else

- [x] Write math example
- [x] Write diagram example
- [ ] Do something else

Setting a callout

This is what a callout looks like

<div class="alert alert-note">
  <div>
    A Markdown callout is useful for displaying notices, hints, or definitions to your readers.
  </div>
</div>


Note: For a warning notification. replace note with warning

Code Based Tables

| Command           | Description                    |
| ------------------| ------------------------------ |
| `hugo`            | Build your website.            |
| `hugo serve -w`   | View your website.             

Python Based Code Highlight

# Example of code highlighting
input_string_var = input("Enter some data: ")
print("You entered: {}".format(input_string_var))

python
# Example of code highlighting
input_string_var = input("Enter some data: ")
print("You entered: {}".format(input_string_var))

Making Flow charts

graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;

Emoticons

I : heart : Wowchemy : smile :

I : heart : Wowchemy : smile :

Terminal
Python
R

{ {< icon name="terminal" pack="fas" >} } Terminal  
{ {< icon name="python" pack="fab" >} } Python  
{ {< icon name="r-project" pack="fab" >} } R

Note: Remove the spaces in the curly bracket.

Adding a blockquote

This is a blockquote.

> This is a blockquote.

IF you want to highlight some text use this

This is a highlighted quote.

This is a { {< hl >} }highlighted quote{ {< /hl >} }.
NOTE: Remote the spaces between the curly brackets.

Taking Foot notes

I have more ¹ to say.

I have more [^1] to say.

[^1]: Footnote example.

Embedding Google Docs

{ {< gdocs src="https://docs.google.com/..." >} }
Note:Remove the Spaces between the Curly brackets

Smiley CheatSheet

https://www.webfx.com/tools/emoji-cheat-sheet/

Highlight come code code

 A bunch of code here 

{ {< highlight go >} } A bunch of code here { {< /highlight >} }
Note: Remove the spaces between curly brackets