窗临窗手记ERIC’S NOTES
阅读随记

日常笔记里,够用的 Markdown 就这几种

标题、列表、链接与代码块,先用少量语法把内容的关系写清楚。

Markdown 的便利之处在于,纯文本本身仍然容易阅读。日常记录并不需要记住所有扩展语法,先用少数几种表达结构,已经能够覆盖很多学习笔记。

标题表达层级

标题用来划分内容结构,不只是把文字变大。一篇笔记可以先写主题,再用二级标题分成几个问题。层级不必太深,否则阅读者需要花很多精力才能知道当前内容属于哪里。

开始写之前可以先列两三个问题作为小标题。写完后再检查标题顺序是否与理解问题的顺序一致,这比一开始调整字体和颜色更能改善阅读。

# 一篇学习笔记

## 要解决的问题
写清楚背景。

## 观察与结论
- 第一条观察
- 第二条观察

链接留下出处

引用文档时,链接文字应描述目标内容,例如配置参数说明,比点击这里更有意义。必要时在链接旁注明版本与阅读日期,以免未来误把旧版本资料当作当前行为。

图片也需要有能够描述内容的替代文字。把关键结论仅放在截图里,会增加搜索和重新整理的难度;可以在图片前后补上简短说明。

代码块保留边界

命令、配置和程序片段适合放进代码块。代码块能保留缩进,并将示例与普通叙述区分开来。复制命令前仍应理解每个参数,尤其是包含删除、覆盖或远程下载的示例。

记录终端输出时,最好区分执行的命令和实际结果,并移除口令、令牌、私钥等敏感内容。文档的可读性不应以泄露访问凭据为代价。

把格式保持在够用的位置

不同编辑器支持的表格、任务清单或数学公式扩展可能不同。需要跨工具迁移的笔记,可以优先使用较基础的语法,并检查目标工具的渲染效果。

格式是整理思路的辅助。先让标题、段落和列表形成清楚的关系,再按需要添加其他表达方式,笔记通常会更容易维护。

— 本篇完 —
把理解写下来,也给下一次思考留下起点。