GitHub 使用 Markdown 方言，称为 GitHub 风格的 Markdown (GFM). It’s mostly standard Markdown with a few extras — fenced code blocks with syntax highlighting, task lists, tables, and automatic link detection. If you’re converting a Word document into a GitHub README or wiki page, here’s what you need to know.
什么是 GitHub 风格的 Markdown？
GFM 是 GitHub 对 CommonMark 的扩展。从 Word 转换时最重要的添加内容是：
- 防护代码块 带有语言标识符（
```python) - 表格 使用管道语法
- 任务列表 using
- [ ]and- [x] - 删除线 using
~~text~~ - 自动链接 — 裸露 URL 变得可点击
将您的 Word 文档转换为 WordToMD ，默认情况下您将获得 GFM 兼容的输出。
Word样式 → GFM 元素
| 词元素 | GFM 输出 |
|---|---|
| 标题 1 | # H1 |
| 标题 2 | ## H2 |
| 粗体 | **bold** |
| 斜体 | *italic* |
| 表 | 管道表 |
| 项目符号列表 | - item |
| 编号列表 | 1. item |
| 超链接 | [text](url) |
| 等宽字体 | `code` |
| 删除线 | ~~text~~ |
转换后添加的 GitHub 特定功能
任务列表
Word 没有本机任务列表元素。如果您的 Word 文档中有复选框，它们会转换为纯文本。转换后，将它们格式化为 GFM 任务列表：
- [x] Completed item
- [ ] Pending item
- [ ] Another pending item这些在 GitHub 问题、拉取请求和项目自述文件中呈现为交互式复选框。
具有语法突出显示的防护代码块
Word 中的等宽字体文本转换为内联代码。对于 GitHub 上的多行代码块，请使用带有语言标识符的隔离语法：
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
GitHub supports dozens of languages. See [Markdown Code Blocks Guide](/blog/markdown-code-blocks-guide) for the full language list and syntax rules.
### Alerts (GitHub-Specific Callouts)
GitHub renders special blockquote syntax as colored callout boxes:
```markdown
> [!NOTE]
> This is a note callout.
> [!WARNING]
> This is a warning.
> [!TIP]
> This is a helpful tip.如果您的 Word 文档有标注框或突出显示的注释，请在初始转换后将它们转换为此 GFM 警报语法。
从 Word 文档构建自述文件
典型的软件自述文件遵循以下结构：
# Project Name
Short description.
## Installation
## Usage
## Configuration
## Contributing
## License如果您的 Word 文档是项目规范或文档草稿，请将其部分映射到这些自述文件标题。使用 WordToMD 转换原始内容，然后重新组织并添加 GitHub 特定的元素。
GitHub Markdown 中的表格
字表直接转换为 GFM 管道表。转换后的表如下所示：
| Feature | Status | Notes |
|---|---|---|
| Authentication | ✅ Done | JWT-based |
| File upload | 🚧 In progress | S3 target |
| API docs | ❌ Pending | — |GitHub 还支持列对齐：
| Left | Center | Right |
|:---|:---:|---:|
| text | text | text |有关 Markdown 表格的所有内容，请参阅 Markdown 表：完整指南.
GitHub 存储库中的图像
GitHub 从存储库中的相对路径渲染图像：
如果 Word 文档包含受支持的图片，请下载 Markdown + 图像 ZIP，将打包好的镜像文件移入 docs/images/，如果您的存储库使用不同的文件夹结构，请更新相对路径。
对于 GitHub.com 托管的图像，您还可以使用绝对 URL： H1
GitHub 维基页面
GitHub wiki 支持完整的 GFM 规范。转换工作流程与自述文件相同：
- 转换您的 Word 文档 WordToMD
- 添加 GFM 特定格式（任务列表、代码围栏、警报）
- 创建一个新的 wiki 页面并粘贴 Markdown
标题 ID 和锚链接
GitHub 从标题文本自动生成锚点 ID。标题 ## Installation 获取 ID #installation. You can link to it from elsewhere in the same document:
See the [Installation section](#installation) below.这对于带有目录的长自述文件非常有用。转换后，在顶部添加TOC：
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)FAQ
GitHub 是否在 Markdown 中呈现 HTML？ GitHub 允许在 Markdown 中使用一些 HTML 标签，但会去除大多数样式属性。坚持使用 Markdown 语法以获得最佳结果。
我的表格列太多，在移动设备上看起来很拥挤。我应该怎么办？
考虑将大表分成更小的集中表，或使用 HTML <details> 可折叠部分的标签。
我可以使用 Word 编写 GitHub Issues 吗？ 是的！将您的 Word 文档转换为 Markdown WordToMD 并将输出直接粘贴到 GitHub 问题或拉取请求描述中。
如何将整个 Word 文档集转换为 GitHub wiki？ 单独转换每个 Word 文件并为每个文档创建一个 wiki 页面。参见 批量将 Word 转换为 Markdown 使用 Pandoc 编写脚本。
结论
将 Word 转换为 GitHub Markdown 很简单——使用 WordToMD 获取基础 Markdown，然后叠加 GFM 特定的功能，如任务列表、代码围栏和标注警报。如果您的 Word 文档结构清晰（内置标题样式、正确的表格），转换输出几乎就可以推送到 GitHub。