写文档多年,Markdown 的潜力远超标题、加粗和链接这些基础用法。几个小技巧能让文档更清晰、易读、好维护,整理如下。
表格适合结构化数据,保持简单并对齐管道符,源码更易扫描;复杂布局别用表格,它更适合对比或参考数据。
任务列表用- [ ]和- [x]跟踪进度,在 README 或项目计划中很实用,多数平台会渲染成可勾选的复选框。
长文档用<details>和<summary>标签做折叠区块,读者按需展开细节,GitHub 等平台均支持。
锚点链接让读者快速跳转到长文特定章节,多数 Markdown 处理器会自动从标题生成锚点。
代码块始终指定语言,并用title=在围栏内标注文件名,GitHub 和 GitLab 等平台会在代码块头部显示。
引用块不止用于引用,加粗标签可作提示、警告等标注;GitHub 的> [!NOTE]语法会渲染彩色框。
需要字面显示 Markdown 字符时用反斜杠转义,写 Markdown 教程时很常用。
嵌套列表注意缩进,统一用两或四个空格创建子项,保持一致即可。
水平分割线---可无标题分隔章节,前后留空行避免被解析成标题。
仓库内文件互链用相对链接而非绝对 URL,文档可移植,重组项目时省去大量修改。
最后,别过度使用这些特性。Markdown 的价值在于纯文本可读性,嵌套过多引用块或用表格做布局时,退一步简化。清晰的文档靠的是明白,不是炫技。
#GitHub #开源 #Markdown #文档 #开发技巧
@GitHubTrendingHub
