Markdown Guide

What is Markdown?

Markdown is a lightweight markup language that allows you to write documents in an easy-to-read and easy-to-write plain text format. It is widely used for documentation, blog posts, and technical writing.

Advantages of Markdown

  • Simple and efficient: Low learning curve, concise syntax, and can be used with any text editor.
  • Cross-platform compatibility: Markdown is supported on many platforms (such as GitHub, Zhihu, Medium) and can be converted to HTML, PDF, and more.
  • Version control friendly: As plain text, Markdown works well with Git for version management. Ideal for notes, blogs, and documentation.

Markdown Syntax Quick Reference

Markdown SyntaxExplanationEffect
*italic*Wrap text with single asterisksitalic
**bold**Wrap text with double asterisksbold
# Heading 1"#" followed by a spaceHeading 1
## Heading 2Similarly for level 3-6Heading 2
[link](http://a)"[]" contains display textlink
![image](http://url/a.png)"[]" contains image nameImage display
> quote" > " followed by a spaceQuote block
* unordered listN/AList item
1. ordered listN/ANumbered list
---Horizontal divider----
`inline code` | Wrap with backticks | inline code
```Code block start/endCode block
Color codesN/AN/A
***bold+italic***Wrap with triple asterisksbold+italic
Center formatUse HTML tagsCentered text

Syntax Examples

Text Formatting

*This is italic text*
**This is bold text**
***This is bold italic text***

Heading Levels

# Heading 1

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

Links and Images

[This is a link](https://www.example.com)
![This is image description](https://example.com/image.jpg)

Quotes

> This is a quote
> 
> Can have multiple lines

Lists

* Unordered list item 1
* Unordered list item 2
* Unordered list item 3

1. Ordered list item 1
2. Ordered list item 2
3. Ordered list item 3

Code

This is an example of `inline code`

This is a code block Can contain multiple lines of code

function hello(){
    alert("hello");
}

Divider

---

Practical Tips

  • Use headings and lists to plan your outline.
  • Use blockquotes for notes or supplementary explanations.
  • Common shortcuts:
    • Bold: Ctrl+B/Cmd+B
    • Italic: Ctrl+I/Cmd+I
    • Insert link: Ctrl+K/Cmd+K
  • Export to other formats: Use Typora, VS Code, or online tools to export as HTML, PDF, etc.
  • Different editors may render indentation and spacing slightly differently, so preview your work.

Use Cases

  • Technical documentation: Widely used for API docs, user manuals, and technical guides
  • Blog writing: Many blog platforms (like GitHub Pages, Hexo) support Markdown format
  • Note-taking: Perfect for personal knowledge management systems like Obsidian, Typora, etc.
  • Resume creation: Create well-structured, easily convertible resume documents

Tool Recommendations

  • Typora: WYSIWYG Markdown editor with multiple export formats, beginner-friendly.
  • VS Code: Powerful code editor, install Markdown plugins for use, essential for programmers.
  • MarkText: Open-source Markdown editor with clean interface and real-time preview.
  • Dillinger: Online tool, no installation required.

Practice Example

  • Task: Write a simple diary entry using Markdown