.md 文件是使用 Markdown 语法编写的文本文件。用记事本打开时,你会看到 #、** 等标记;用支持 Markdown 的阅读器打开时,这些标记会显示为标题、粗体、列表和表格。
如果你想阅读文档,而不是研究源代码,可以先在浏览器中预览。
.md 文件。不需要为了阅读而把文件改成 .txt。修改扩展名也不会把 Markdown 转成 Word 或 PDF。
# 会议记录
本周需要确认 **两个事项**。
- 日期
- 负责人
| 事项 | 状态 |
| --- | --- |
| 初稿 | 待审核 |
预览后,你应该看到标题、粗体、列表和表格。如果显示的仍是全部源代码,检查是否把整个文档包在了代码围栏中。用于演示语法的代码块会保留标记,不会按普通正文渲染。
阅读器主要用于查看已经写好的文档,编辑器用于修改 Markdown 源文件。有些工具同时提供编辑和预览,但不要假设所有阅读器都能编辑文件。
需要共同修改或在 Git 中管理时,应保留 .md 原文件。需要让别人方便阅读时,可以使用渲染后的页面。两者服务于不同的工作步骤。
 引用了另一个文件。只有 MD 文件、没有对应图片时,阅读器可能无法显示它。先检查文件的位置和相对路径,不要直接删除图片语法。
分享文档时,要确保接收者也能访问图片地址。电脑上的绝对路径通常不能在别人的设备上使用。本地图片与相对链接说明(英文)提供了路径示例。
能显示标题和表格,并不代表工具一定支持 Mermaid 或数学公式。Mermaid 代码块需要标注 mermaid,而且图表语法本身必须正确。先测试简短示例,再检查复杂文档。
导出 PDF 前,检查图表文字、长代码行和宽表格是否可读。导出与在线分享是不同操作;不要把浏览器预览误认为已经发布。
查看文档是否包含密码、API 密钥、个人信息或不应公开的备注。创建分享链接后,还要确认可见性和有效期。持有链接的人可能会继续转发它。
阅读文件可以从 mdview.io开始。需要发送可阅读的链接时,请参考Markdown 分享指南(英文)。