style-guide.md

Flutter 中文文档排版指南

本指南规定了 Flutter 中文文档的排版规范，所有翻译和修改必须遵循这些规则。

---

核心排版规则

1. 链接格式

规则：链接前后必须加空格（中文与链接之间）

❌ 错误示例：

请先从[学习路径页面](/learn/pathway)开始。

✅ 正确示例：

请先从 [学习路径页面](/learn/pathway) 开始。

2. 强调格式

规则：使用加粗（**text**）代替斜体（_text_）来表示强调

❌ 错误示例：

_Model-View-ViewModel_，即 _MVVM_。

✅ 正确示例：

**Model-View-ViewModel**，即 **MVVM**。

原因：斜体在中文排版中不够明显，加粗更符合中文阅读习惯。

3. 加粗前后空格

规则：加粗文本前后需要加空格（中文与加粗之间）

❌ 错误示例：

这是一个**重要**的概念。

✅ 正确示例：

这是一个 **重要** 的概念。

例外：

• 如果加粗文本在句首或句尾，则不需要在边界处加空格
• 如果加粗文本与标点符号相邻，标点符号一侧不加空格

示例：

**重要提示**：请注意以下内容。
这个概念非常 **重要**。

4. 中英文混排

规则：中文与英文/数字之间加空格

✅ 正确示例：

了解 Flutter 的基本构成要素
第 3 步
使用 Dart 语言

5. 代码与反引号

规则：反引号内的代码不翻译，反引号前后加空格（中文与代码之间）

✅ 正确示例：

使用 `setState()` 方法更新状态
创建一个 `StatefulWidget` 类

---

检查清单

在提交翻译前，请确认：

• 所有链接前后都有空格
• 没有使用斜体（_text_）表示强调
• 所有强调都使用加粗（**text**）
• 加粗文本前后有空格（除非在句首/句尾或与标点相邻）
• 中英文之间有空格
• 中文与数字之间有空格
• 代码反引号前后有空格

---

自动化检查

可以使用以下命令检查常见格式问题：

# 检查链接前后是否缺少空格（中文字符紧邻链接）
grep -rn '[一-龥]\[.*\]([^)]*)[一-龥]' src/content/

# 检查是否使用了斜体
grep -rn '_[^_]*_' src/content/ | grep -v '://' | grep -v 'ignore:'

# 检查加粗前后是否缺少空格
grep -rn '[一-龥]\*\*[^*]*\*\*[一-龥]' src/content/