Comprehensive Markdown Tutorial

Headers

Create headers by prefacing the text with one or more # symbols. The number of # you use determines the size of the header.

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Emphasis

Emphasize text with bold or italics.

*italicized text*
**bold text**
***bold and italicized text***

Lists

Create ordered and unordered lists.

- Unordered list item 1
- Unordered list item 2
  - Nested unordered list item

1. Ordered list item 1
2. Ordered list item 2
   1. Nested ordered list item
  • Unordered list item 1
  • Unordered list item 2
    • Nested unordered list item
  1. Ordered list item 1
  2. Ordered list item 2
    1. Nested ordered list item

Include hyperlinks with text.

[GitHub](http://github.com)

GitHub

Images

Embed images using the following syntax.

![alt text for the image](image-url.jpg)

alt text for the image

Code

Add inline code with single backticks, and code blocks with triple backticks.

`inline code`

for i < 5

code block

print(‘Hello, world!’)

Tables

Organize data into tables.

| Header 1    | Header 2    |
| ----------- | ----------- |
| Row 1 Col 1 | Row 1 Col 2 |
| Row 2 Col 1 | Row 2 Col 2 |
Header 1 Header 2
Row 1 Col 1 Row 1 Col 2
Row 2 Col 1 Row 2 Col 2

Blockquotes

Use blockquotes to quote text.

> This is a blockquote.

This is a blockquote.

Horizontal Rules

Create a horizontal line or page break.

---

Extended Syntax

Strikethrough 

~~Strikethrough text~~

Strikethrough text

Fenced Code Blocks

{ “firstName”: “John”, “lastName”: “Smith”, “age”: 25 }

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

Footnotes

Create a footnote like this.1

Heading IDs 

### My Great Heading {#custom-id}

Definition Lists 

term
: definition

term2
: definition2

Task Lists 

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

More

For more advanced Markdown syntax, check the official documentation.

Conclusion

Now you can use Markdown to format your documentation content. Remember to preview your changes locally before pushing them to your GitHub repository.

  1. This is the footnote. ↩