Featured image of post Markdown Syntax Guide

Markdown Syntax Guide

Heading Level

🏷️Definition

  • The heading level can be set from 1 to 6 and its font size is from large to small.
  • Use the ‘#’ symbol followed by a space at the beginning of a line to define a heading, with more symbols indicating smaller levels.

✏️Write a Sample

##### This is level 5  
###### this is level 6

🌟Preview Effect

This is level 5
this is level 6

Line Break

🏷️Definition
     Add two or more spaces followed by an Enter to create a new line.

✏️Write a Sample

This is the first line.  
And this is the second line.	

🌟Preview Effect
This is the first line.
And this is the second line.


Emphasis

1. Text Bold

🏷️Definition
     Add two asterisks or underscores at the beginning and end of a word or statement.

✏️Write a Sample

I just love **bold text**.  
I just love __bold text__.	

🌟Preview Effect
I just love bold text.
I just love bold text.

2. Text Italic

🏷️Definition
     Add one asterisk or underscore at the beginning and end of a word or statement.

✏️Write a Sample

Italicized text is the *cat's meow*.  
Italicized text is the _cat's meow_.

🌟Preview Effect
Italicized text is the cat’s meow.
Italicized text is the cat’s meow.

3. Text Blod and Italic

🏷️Definition

  • Add three asterisks or underscores at the beginning and end of a word or statement.
  • Either combine two asterisks with one underscores or two underscores with one asterisk.

✏️Write a Sample

This text is ***really important***.  
This text is ___really important___.  
This text is **_really important_**.  
This text is __*really important*__.

🌟Preview Effect
This text is really important.
This text is really important.
This text is really important.
This text is really important.


Text Color

🏷️Definition
     Use the HTML grammer to set font colors.

✏️Write a Sample

<font color=Red>Test1</font>  
<font color=#0000FF>Test2</font>  
<font style=background:red>Test3</font>

🌟Preview Effect
Test1
Test2
Test3


Text Strikethrough

🏷️Definition
     Add two tilde symbols at the beginning and end of the word or statement.

✏️Write a Sample

~~The world is flat.~~  
We now know that the world is round.

🌟Preview Effect
The world is flat.
We now know that the world is round.


Blockquotes

🏷️Definition

  • Add a ‘>’ (greater than) symbol in front of a statement.
  • For multiple paragraphs. Add a > on the blank lines between the paragraphs.

✏️Write a Sample

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

🌟Preview Effect

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.


Lists

1. Ordered Lists

🏷️Definition

  • Add line items with numbers followed by periods.
  • The numbers don’t have to be in numerical order, but the list should start with the number one.

✏️Write a Sample

1. First item
2. Second item
3. Third item
    1. Indented item
    1. Indented item
4. Fourth item

🌟Preview Effect

  1. First item
  2. Second item
  3. Third item
    1. Indented item
    2. Indented item
  4. Fourth item

2. Unordered Lists

🏷️Definition
     Add dashes (-), asterisks (*), or plus (+) in front of line items.

✏️Write a Sample

* First item
* 1968\. A great year!
* Third item

🌟Preview Effect

  • First item
  • 1968. A great year!
  • Third item

Horizontal Line

🏷️Definition
     Add three dashes (-), asterisks (*), or underscores (_) on a line by themselves.

✏️Write a Sample

***  
---  
___

🌟Preview Effect





1. With Title

🏷️Definition
     Enclose the content of title in quotation marks after the URL.

✏️Write a Sample

My favorite search engine is [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy").

🌟Preview Effect
My favorite search engine is Duck Duck Go.

2. Literal URL and Email

🏷️Definition
     Enclose the content in angle brackets.

✏️Write a Sample

<https://www.markdownguide.org>
<fake@example.com>

🌟Preview Effect
https://www.markdownguide.org
fake@example.com

3. Internal Section

🏷️Definition
     Enclose the heading Id in the parentheses.

✏️Write a Sample

click this [jump to the With Tile](#1-with-title)

🌟Preview Effect
click this jump to the With Tile

4. Disable Auto URL Linking

🏷️Definition
     Denoting the URL as code with backticks.

✏️Write a Sample

`http://www.example.com`

🌟Preview Effect
http://www.example.com


Images

🏷️Definition
     Enclose the path of the image in brackets, and then add the link in parentheses.

✏️Write a Sample

![destImg](./assets/images/tux.jpg "beautiful")

🌟Preview Effect
destImg


Escaping Characters

🏷️Definition

Add a backslash (\) in front of the character.

✏️Write a Sample

\* Without the backslash, this would be a bullet in an unordered list.

🌟Preview Effect
* Without the backslash, this would be a bullet in an unordered list.


Embeded HTML Tags

🏷️Definition
     Place the tags in the text of your Markdown-formatted file.

✏️Write a Sample

This **word** is bold. This <em>word</em> is italic.

🌟Preview Effect
This word is bold. This word is italic.


Tables

🏷️Definition

  • Use three or more hyphens (—) to create each column’s header, and use pipes (|) to separate each column.
  • Align text in the columns to the left, right, or center by adding a colon (:) to the left, right, or on both side of the hyphens within the header row.

✏️Write a Sample

| Syntax      | Description | Test Text     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here's this   |
| Paragraph   | Text        | And more      |

🌟Preview Effect

Syntax Description Test Text
Header Title Here’s this
Paragraph Text And more

Fenced Code Blocks

🏷️Definition

  • Use three backticks (```) or three tildes (~~~) on the lines before and after the code block.
  • pecify a language next to the backticks before the fenced code block to highlight codes.

✏️Write a Sample

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

🌟Preview Effect

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Task Lists

🏷️Definition

  • Add dashes (-) and brackets with a space ( ) in front of task list items.
  • To select a checkbox, add an x in between the brackets ( ).

✏️Write a Sample

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

🌟Preview Effect

  • Write the press release
  • Update the website
  • Contact the media
Licensed under CC BY-NC-SA 4.0
MoziCSH
Built with Hugo
Theme Stack designed by Jimmy