本地处理
DEVDESK / GUIDES

Markdown README 排版:表格、任务列表与换行

README 在编辑器里整齐,预览却挤成一段?从最小片段开始检查空行、分隔符和缩进。下面的清单可以直接粘贴到本站 Markdown 工具,逐项修改并比较预览。

打开工具:Markdown 编辑与预览

1. 建立一份可复现的清单

先确认标题、两项任务和两列的表格都显示正确,再粘贴真实文档。若完整文档有问题而此示例正常,就从前面的未闭合代码围栏或列表缩进开始检查。

# Release checklist

- [x] Check API response
- [ ] Publish README

| Item | Result |
| --- | --- |
| JSON | Valid |
| Docs | Pending |

2. 表格需要表头分隔行

第二行的 --- 用来区分表头和正文。试着删除这一行,再恢复,观察表格是否被当作普通文本。内容包含竖线时,用反斜杠转义,避免多出一列。

| Expression | Meaning |
| --- | --- |
| a\|b | a or b |

3. 区分段落、软换行与硬换行

空行会开始新段落。同一段落中的单次回车通常是软换行;需要明确断行时,可在行末加两个空格再回车。本站不把每一次回车都转换为可见换行。

复制示例时注意尾部空格可能被编辑器移除。可以在文本对比工具中比较修改前后源文件,定位意外删掉的空白。

4. 用代码围栏保留原样文本

三条反引号围住的内容按代码显示,里面的尖括号不会成为页面标签。确保开始与结束围栏成对;任务的完成状态请在源文件里把 [ ] 改成 [x]。

```json
{"status":"ready","count":2}
```

5. 保存源文件,并检查导出效果

下载 Markdown 可继续编辑;导出 HTML 保存经过过滤的预览。本站会移除原始 HTML 和图片,不适合验证依赖 iframe、脚本或外部图片的文档。

切换工具、刷新或关闭页面前先下载。最后在真正发布 README 的平台上再检查一次,因为字体、渲染器和过滤规则可能不同。

继续动手验证