Expand

This is a draft

The Complete Guide to Markdown

Basic Text Formatting

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text Emphasis

*Italic text* or _italic text_
**Bold text** or __bold text__
***Bold and italic*** or ___bold and italic___
~~Strikethrough text~~

Lists

Unordered lists:

* Item 1
* Item 2
  * Nested item 2.1
  * Nested item 2.2
* Item 3

- Or use hyphens
- Instead of asterisks

Ordered lists:

1. First item
2. Second item
   1. Nested item 2.1
   2. Nested item 2.2
3. Third item

Links and Images

Links:

[Link text](https://www.example.com)
[Link with title](https://www.example.com "Title text")

Images:

![Alt text](image.jpg)
![Alt text](image.jpg "Image title")

Blockquotes

> This is a blockquote
> Multiple lines
>> Nested blockquote

Advanced Formatting

Code Blocks

Inline code:

Use `backticks` for inline code

Fenced code blocks:

```python
def hello_world():
    print("Hello, World!")
```

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

// Alignment options
| Left     | Center   | Right    |
|:---------|:--------:|----------:|
| Left     | Center   | Right    |

Horizontal Rules

---
***
___

Task Lists

- [x] Completed task
- [ ] Uncompleted task
  - [x] Nested completed task
  - [ ] Nested uncompleted task

Escaping Characters

\* Asterisk
\` Backtick
\[ Square bracket
\( Parenthesis
\# Hash symbol
\. Period
\! Exclamation mark

Best Practices

Always leave a blank line before and after:
- Headers
- Lists
- Code blocks
- Blockquotes
Use consistent formatting for emphasis (stick to either asterisks or underscores)
For nested lists:
- Use 2 spaces for unordered lists
- Use 3 spaces for ordered lists
Keep headers hierarchical (don’t skip levels)
Use reference-style links for better readability in long documents:

[link text][reference]

[reference]: https://www.example.com

Common Applications

Documentation: READMEs, wikis, and technical docs
Note-taking: Personal notes and study materials
Blog posts: Content formatting
Comments: GitHub issues and pull requests
Documentation sites: Jekyll, GitBook, and other static site generators

Remember: Different platforms may support varying levels of Markdown syntax. GitHub, for example, has its own flavor called GitHub Flavored Markdown (GFM) with additional features.

Need Help?For assistance, please visit our support center.

Markdown Codes