返回博客
2025年11月17日星期一

Markdown 语法终极速查表:从新手到专家

Markdown 语法终极速查表:从新手到专家

这份全面的 Markdown 语法速查表涵盖了从基础到高级的所有语法,配合 Markdown2Image 工具,可以轻松创建专业级的技术文档、教程和分享图表。

🎯 核心优势

  • 一表掌握所有语法 - 从基础格式到高级功能全覆盖
  • 实用示例丰富 - 每个语法都配有实际使用场景
  • 专业输出支持 - 完美适配 Markdown2Image 转换需求
  • 多平台兼容 - 确保在所有主流 Markdown 渲染器中正常工作

📝 基础文本格式化

强调与重点

*斜体文本* 用于一般强调
**粗体文本** 用于强烈强调
***粗斜体文本*** 用于最强烈的强调
`行内代码` 用于技术术语
~~删除线文本~~ 表示内容不再有效

实际应用示例:

  • 重要提示:请仔细阅读以下内容
  • 注意事项:这个功能仍在测试阶段
  • 命令格式npm install package-name
  • 已弃用:这个方法在新版本中已不再推荐

高级文本格式

==高亮文本== 使用特定平台支持的下划线标记
<u>下划线文本>> 通用下划线语法
^[上标文本^] 上标显示
~[下标文本]~ 下标显示

🔗 链接与引用

基础链接

[普通链接](https://example.com)
[带标题的链接](https://example.com "鼠标悬停时显示的标题")
[相对链接](../other-file.md)
[锚点链接](#章节名称)

高级链接技术

[邮件链接](mailto:user@example.com)
[电话链接](tel:+861234567890)
[下载链接](download/file.pdf "点击下载 PDF 文件")
[外部链接在新窗口打开](https://example.com){target="_blank"}

参考式链接(长文档推荐)

首先在文档中定义参考:
[GitHub]: https://github.com "全球最大的代码托管平台"
[Google]: https://google.com "全球最大的搜索引擎"

然后在正文中使用:
欢迎访问 [GitHub] 和 [Google] 获取更多资源。

这种方式让文档更整洁,链接管理更方便。

🖼️ 图片与媒体

基础图片

![替代文本](image.jpg)
![带标题的图片](image.jpg "图片标题")
![相对路径图片](./images/logo.png)
![网络图片](https://example.com/image.jpg)

高级图片功能

![指定尺寸的图片](image.jpg =300x200)
![指定宽度的图片](image.jpg =500x)
![点击放大的图片](image.jpg "点击查看大图"){data-zoomable}
![居中对齐的图片](image.jpg){align=center}
![左对齐的图片](image.jpg){align=left}

图片组合与说明

![工作流程图](workflow.jpg)

*图 1:完整的工作流程示意图,展示了从数据输入到结果输出的全过程*

> **💡 提示**:在 Markdown2Image 中,图片会自动优化并保持高质量输出。

📊 列表与组织结构

无序列表

- 主要任务 1
  - 子任务 1.1
  - 子任务 1.2
- 主要任务 2
  - 子任务 2.1
- 主要任务 3

有序列表

1. 第一步:项目初始化
2. 第二步:环境配置
   1. 安装依赖包
   2. 配置数据库
   3. 设置环境变量
3. 第三步:功能开发
4. 第四步:测试与部署

任务列表(待办事项)

- [x] 完成的任务
- [ ] 进行中的任务
- [ ] 待开始的任务
- [x] 另一个完成的任务

### 复杂任务结构
```markdown
- [x] 项目架构设计
  - [x] 技术选型
  - [x] 数据库设计
  - [ ] API 设计
  - [ ] 前端框架选择
- [ ] 核心功能开发
  - [ ] 用户认证模块
  - [ ] 数据处理模块
  - [ ] 报表生成模块

定义列表(术语解释)

Markdown
: 一种轻量级标记语言,用于格式化文本文档

CMS (Content Management System)
: 内容管理系统
: 用于创建、管理和发布数字内容的软件平台

API (Application Programming Interface)
: 应用程序编程接口
: 定义软件组件之间交互的规范

📑 标题与文档结构

标题层级(完整6级)

# 一级标题 (H1) - 文档主标题
## 二级标题 (H2) - 主要章节
### 三级标题 (H3) - 子章节
#### 四级标题 (H4) - 详细内容
##### 五级标题 (H5) - 具体细节
###### 六级标题 (H6) - 最细粒度

标题最佳实践

  • 每个文档只用一个 H1,作为文档主标题
  • 保持层级连续,不要跳跃使用标题级别
  • 标题内容要简洁明确,能够准确概括段落内容
  • 使用结构化标题:"操作 + 对象"格式(如:"安装 Python 环境")

💬 引用与注释

基础引用

> 这是一个引用块,用于突出重要内容或引用他人观点。
> 引用块可以包含多行内容,保持原有的格式和结构。
> 
> 可以在引用块中使用其他 Markdown 语法,如 **粗体** 和 `代码`。

嵌套引用

> 外层引用内容
>> 内层引用内容
>>> 更深层级的嵌套引用
>>> 最深层的引用内容

引用来源标注

> 优秀的代码不仅是能运行的代码,更是易于理解、维护和扩展的代码。
> 
> —— Robert C. Martin《代码整洁之道》

> 天才就是 1% 的灵感加上 99% 的汗水。
> 
> —— 托马斯·爱迪生

💻 代码展示与语法高亮

行内代码

在 Python 中使用 `print()` 函数输出内容。
数据库连接字符串示例:`"Server=localhost;Database=test;"`

代码块与语法高亮

// JavaScript 示例
function calculateTotal(items) {
  return items.reduce((sum, item) => sum + item.price * item.quantity, 0);
}

const cart = [
  { name: "苹果", price: 5.99, quantity: 3 },
  { name: "香蕉", price: 2.49, quantity: 5 }
];

const total = calculateTotal(cart);
console.log(`购物车总价:$${total.toFixed(2)}`);

多语言代码展示

# Python 示例
def calculate_average(numbers):
    """计算数字列表的平均值"""
    if not numbers:
        return 0
    return sum(numbers) / len(numbers)

scores = [85, 92, 78, 95, 88]
average = calculate_average(scores)
print(f"平均分:{average:.2f}")
# Shell 脚本示例
#!/bin/bash

# 自动部署脚本
echo "开始部署应用程序..."
git pull origin main
npm install
npm run build
npm run start

echo "部署完成!"
-- SQL 查询示例
SELECT 
    u.name,
    u.email,
    COUNT(o.id) as order_count,
    SUM(o.total) as total_spent
FROM users u
LEFT JOIN orders o ON u.id = o.user_id
WHERE u.created_at >= '2024-01-01'
GROUP BY u.id, u.name, u.email
HAVING COUNT(o.id) > 0
ORDER BY total_spent DESC
LIMIT 10;

📋 表格与数据展示

基础表格

| 姓名 | 年龄 | 城市 | 职业 |
|------|------|------|------|
| 张三 | 28 | 北京 | 软件工程师 |
| 李四 | 32 | 上海 | 产品经理 |
| 王五 | 25 | 深圳 | 设计师 |

对齐表格

| 居左对齐 | 居中对齐 | 居右对齐 |
|:---------|:--------:|---------:|
| 文本内容 | 数字数据 | 金额数值 |
| 较长文本 | 居中显示 | 右对齐金额 |

复杂表格示例

| 产品名称 | 价格 | 库存 | 状态 | 最后更新 |
|----------|------|------|------|----------|
| MacBook Pro | ¥12,999 | 15 | ✅ 可售 | 2024-01-15 |
| iPhone 15 | ¥5,999 | 0 | ❌ 缺货 | 2024-01-14 |
| iPad Air | ¥4,599 | 8 | ⚠️ 库存低 | 2024-01-13 |

**表格说明:**
- ✅ 可售:库存充足,正常销售
- ❌ 缺货:暂时无货,预计下周补货
- ⚠️ 库存低:库存较少,建议及时补货

🎯 其他重要功能

水平分割线

---
***
___

转义字符

\* 显示星号而不是斜体
\` 显示反引号而不是代码
\# 显示井号而不是标题
\\ 显示反斜杠

内联 HTML(高级功能)

<details>
<summary>点击展开详细信息</summary>

这里是隐藏的内容,用户可以点击标题来展开查看。

包含技术细节、配置信息等。

</details>

<kbd>Ctrl</kbd> + <kbd>C</kbd> 复制
<kbd>Cmd</kbd> + <kbd>V</kbd> 粘贴

表情符号支持

:smile: 😊 :heart: ❤️ :rocket: 🚀 :star: ⭐
:warning: ⚠️ :information_source: ℹ️ :question: ❓
custom emoji: :custom_name:

🎨 Markdown2Image 输出优化技巧

图片导出最佳实践

  1. 结构清晰:使用明确的标题层级,保持逻辑结构
  2. 内容精炼:避免过长的段落,适当使用列表和表格
  3. 代码优化:使用语法高亮,选择合适的字体大小
  4. 图片处理:确保图片清晰,添加描述性替代文本
  5. 颜色对比:确保文本与背景有足够的对比度

推荐导出设置

  • 格式选择:PNG 适合大多数用途,SVG 适合矢量图形
  • 尺寸建议
    • 社交媒体分享:1200x630px 或 1080x1080px
    • 技术文档:1920x1080px 或更高
    • 移动端优化:1080x1920px
  • 字体大小:正文 14-16px,代码 12-14px
  • 行间距:1.5-1.7 倍,确保可读性

实用模板示例

API 文档模板

# API 接口文档

## 用户认证

### 请求示例
```bash
curl -X POST https://api.example.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"user","password":"pass"}'

响应格式

{
  "status": "success",
  "data": {
    "token": "jwt_token_here",
    "user": {
      "id": 123,
      "name": "用户名"
    }
  }
}

教程模板

# 快速入门指南

## 第一步:环境准备

1. 安装必要软件
2. 配置开发环境
3. 克隆项目代码

## 第二步:基本操作

### 创建第一个文件
```bash
mkdir my-project
cd my-project
echo "# 我的项目" > README.md

常见问题解决

问题:权限不足

sudo chown -R $USER:$USER ./my-project

🚀 高级技巧与窍门

键盘快捷键

  • 粗体:选中文本 → Ctrl+B / Cmd+B
  • 斜体:选中文本 → Ctrl+I / Cmd+I
  • 代码:选中文本 → Ctrl+Shift+C / Cmd+Shift+C
  • 链接:选中文本 → Ctrl+K / Cmd+K

效率提升技巧

  1. 使用模板:为常用内容类型创建 Markdown 模板
  2. 批量操作:使用查找替换功能进行批量格式修改
  3. 实时预览:使用支持实时预览的编辑器
  4. 版本控制:将 Markdown 文件纳入 Git 管理

专业写作建议

  • 保持一致性:在整个文档中使用统一的格式风格
  • 考虑受众:根据读者背景调整技术深度和解释详细程度
  • 添加注释:为复杂代码和概念添加清晰的说明
  • 使用示例:提供实际可运行的示例代码
  • 定期更新:保持文档内容的时效性和准确性

📋 快速参考卡片

最常用元素速查

元素语法示例输出结果
粗体**text****重要**重要
斜体*text**提示*提示
代码`code``npm`npm
链接[text](url)[官网](https://example.com)官网
图片![alt](src)![Logo](logo.png)Logo
列表- item- 任务- 任务
标题# title# 章节# 章节
引用> text> 提示> 提示

特殊字符转义

字符转义语法说明
*\*星号
``反引号
##井号
&&和号
$$美元符号
%%百分号

🎯 实际应用场景

1. 技术文档编写

  • API 接口文档
  • 用户使用手册
  • 开发者指南
  • README 文件

2. 内容创作

  • 技术博客文章
  • 项目介绍文档
  • 产品说明文档
  • 知识库文章

3. 教育培训

  • 课程大纲
  • 学习笔记
  • 实验指导书
  • 考试复习资料

4. 项目管理

  • 需求文档
  • 设计规范
  • 会议记录
  • 进度报告

📚 扩展学习资源

官方资源

工具推荐

  • 编辑器:Typora, Mark Text, VS Code + Markdown 插件
  • 在线工具:Dillinger, StackEdit, Markdown Live Preview
  • 转换工具:Pandoc, Markdown2Image, GitHub Pages

进阶主题

  • Mermaid 图表语法
  • LaTeX 数学公式
  • 自定义 CSS 样式
  • 自动化文档生成

💡 终极提示:掌握 Markdown 不仅是学习语法,更是培养结构化思维。结合 Markdown2Image 工具,你可以将任何 Markdown 文档转换为精美的分享图片,让技术知识传播更加高效和美观。

立即行动:选择一个你最常用的 Markdown 场景,使用这份速查表优化你的文档,然后用 Markdown2Image 创建专业的分享图片!

Markdown To Image | Markdown 语法终极速查表:从新手到专家 | MarkdownToImage