Markdown 完全使用指南

Markdown 是一种轻量级标记语言，让你能用易读易写的纯文本格式编写文档，并可以转换为结构化的 HTML。

📋 基础语法

1. 标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2. 文本样式

**粗体文本** 或 __粗体文本__
*斜体文本* 或 _斜体文本_
***粗斜体文本*** 或 ___粗斜体文本__
~~删除线文本~~
<u>下划线文本</u>（部分扩展支持）

3. 列表

无序列表

- 项目一
- 项目二
  - 子项目一
  - 子项目二
* 也可以使用星号
+ 或加号

有序列表

1. 第一项
2. 第二项
   1. 子项一
   2. 子项二
3. 第三项

任务列表

- [x] 已完成任务
- [ ] 未完成任务
- [ ] 另一个任务

4. 链接和图片

[链接文本](https://example.com)
![图片描述](图片地址)
![图片描述](图片地址 "可选标题")

高级用法：
[参考式链接][1]
[1]: https://example.com

带格式的链接：
[**粗体链接**](https://example.com)

5. 引用

> 引用文本
> 
> 多行引用
> 
> > 嵌套引用

6. 代码

行内代码

使用 `printf()` 函数

代码块

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

```javascript
console.log("Hello");
```

7. 表格

| 表头1 | 表头2 | 表头3 |
|-------|-------|-------|
| 单元格1 | 单元格2 | 单元格3 |
| 左对齐 | 居中对齐 | 右对齐 |
|:------|:------:|------:|

简化写法：
表头1 | 表头2 | 表头3
-----|-----|-----
内容1 | 内容2 | 内容3

8. 分割线

---
***
___

🔧 扩展语法（部分平台支持）

1. 脚注

这是带有脚注的文本[^1]

[^1]: 这里是脚注内容

2. 定义列表

术语1
: 定义1

术语2
: 定义2
: 第二个定义

3. 缩写

*[HTML]: HyperText Markup Language
*[CSS]: Cascading Style Sheets

现在可以使用 HTML 和 CSS 缩写

4. 目录（某些工具支持）

[TOC]  # 自动生成目录

5. 数学公式（部分平台支持）

行内公式：$E = mc^2$

块级公式：
$$
\sum_{i=1}^n i = \frac{n(n+1)}{2}
$$

🎨 高级技巧

1. 转义字符

\# 不显示为标题
\* 不显示为斜体
\\ 反斜杠

2. HTML 混用

<p style="color: red;">红色文字</p>
<br>  <!-- 强制换行 -->
<kbd>Ctrl</kbd>+<kbd>C</kbd>  <!-- 键盘按键 -->

3. 自动链接

<https://example.com>
<email@example.com>

4. Emoji 表情

:smile: :heart: :rocket: :+1:

📁 文件扩展名

  • .md - Markdown 文件
  • .markdown - Markdown 文件
  • .mdown - 某些系统使用

🔍 最佳实践

  1. 保持一致性

    • 统一使用一种列表符号
    • 统一标题层级风格

  2. 可读性优先

    • 行宽控制在 80-100 字符
    • 适当使用空行分段

  3. 结构化文档

    # 文档标题

简短描述

## 目录

## 安装

## 使用

## API 参考

## 示例

## 常见问题

## 许可证

  4. 版本控制友好

    • 每个段落单独一行
    • 避免尾随空格

🛠️ 工具推荐

编辑器

  • Visual Studio Code + Markdown扩展
  • Typora - 所见即所得
  • Obsidian - 知识管理
  • Notion - 在线协作

转换工具

  • Pandoc - 格式转换
  • Markdown Preview Enhanced - VS Code扩展
  • GitHub Flavored Markdown - GitHub风格

在线工具

  • StackEdit - 在线编辑器
  • Dillinger - 实时预览
  • Markdown Tables Generator - 表格生成

📚 不同平台差异

平台 特色功能 注意事项
GitHub 任务列表、表格、emoji 支持相对链接
GitLab 类似GitHub，支持更多emoji 更强的引用功能
Reddit 简化版Markdown 不支持表格
Discord 支持部分语法 平台特定格式
Jupyter 支持LaTeX公式 交互式文档

💡 实用示例

README.md 模板

# 项目名称

![项目徽章](https://img.shields.io/badge/版本-1.0.0-blue)
![许可证](https://img.shields.io/badge/许可证-MIT-green)

简短的项目描述。

## ✨ 特性

- ✅ 功能一
- ✅ 功能二
- 🔄 功能三（开发中）

## 🚀 快速开始

### 安装

```bash
npm install package-name

使用

const package = require('package-name');
package.doSomething();

📖 详细文档

查看完整文档

🤝 贡献指南

请阅读 CONTRIBUTING.md

📄 许可证

本项目基于 MIT 许可证 - 查看 LICENSE 文件
```

🔄 学习资源

  1. 官方资源

  2. 练习工具

  3. 进阶学习

    • Learn Markdown in 60 seconds
    • Markdown 表格生成器
    • Pandoc 文档转换

小提示：Markdown 的核心思想是 可读性优先。即使不经过渲染，你的文档也应该清晰易读。现在就开始用 Markdown 记录你的想法吧！🎉