使用Markdown记录学习笔记

选择标题层次结构

使用一个主标题和逻辑部分级别。标题应该确定一个主题或主张，而不仅仅是创建更大的文本。一致的级别使目录变得有用。

从标识主题和会议的主标题开始，然后使用二级标题表示主要思想，使用三级标题表示真正的细分。例如，关于实验设计的注释可能包含问题、方法、证据和限制等部分。避免仅仅为了获得首选字体大小而跳过标题级别。如果标题包含整个段落，请将其缩短为预测下面内容的短语。阅读没有正文的标题，并询问它们是否提供了有用的主题图。连贯的层次结构有助于手动导航和生成的内容列表，而任意的标题级别可能会使简短的注释比其开头的无格式文本更难浏览。

保持列表有意义

使用项目符号表示平行点，使用编号步骤表示序列。不要仅仅因为项目符号列表输入速度更快而用不连贯的片段替换因果解释。

根据含义选择列表结构。当一个过程必须按顺序发生时，使用有序列表；当项目是并行替代项或功能时，使用项目符号。当关系会像碎片一样消失时，在句子中保留因果解释。如果项目符号引入了一个条件，请将该条件包含在其符合条件的声明中，而不是将其放在遥远的子列表中。将嵌套限制为您可以清楚解释的关系，例如其说明的原则下的示例。清理后，检查缩进是否仍然在目标编辑器中表达这些关系。 Markdown 实现有所不同，因此如果间距或列表约定与您打算使用的查看器不匹配，视觉上可接受的源文件可能会意外呈现嵌套项目。

保护代码和公式

对间距很重要的代码或符号使用围栏块。清理器保留栅栏内的内容，而不是在那里应用普通的标题和项目符号标准化。

将间距重要的代码包装在围栏块中，并在编辑器支持时包含语言标签。将散文保留在块之外，以便可以在不影响示例的情况下对其进行规范化。对于方程式，请使用目标渲染器实际理解的符号；普通 Markdown 并不能保证数学排版。带有解释的纯文本方程可能比不受支持的标记更便携。检查打开和关闭栅栏是否成对，因为未闭合的栅栏可能会使文档的其余部分表现得像代码。清理程序保留受隔离内容的决定可以保护有意的格式，但它无法确定代码是否运行或数学是否正确。使用适当的课程材料或执行环境验证这些声明。

运行清洁器

粘贴 Markdown 并生成标准化标题和项目符号。在更换源之前阅读输出。该实用程序重新格式化文本；它并不验证每种 Markdown 方言或正确的学术内容。

在将原始文本粘贴到清洁器中之前先保存原始文本，尤其是当它包含长轮廓或不寻常的符号时。从一个有代表性的部分开始，其中包括标题、项目符号和一个围栏示例。在处理整个文档之前，逐行比较这些结构的输出。规范化过程应该使约定保持一致，但它可能不匹配编辑器支持的每个扩展，例如特殊标注或嵌入式组件。将任何不受支持的结构保留在单独的审查列表中，并在最终源中故意修复它。不要仅仅因为工具中的输出看起来更整洁而替换您唯一的副本。正确的学术意义和完整的源内容比在整个文件中实现统一的标点符号更重要。

检查内容列表

该工具根据标题创建锚点并添加重复的后缀。在目标编辑器中预览链接，因为不同的渲染器可以使用不同的锚点约定。

生成内容列表后，测试指向第一个标题、包含标点符号的标题和任何重复标题的链接。两个部分都称为“示例”，需要不同的目的地；后缀可以在一个渲染器中区分它们，而另一个渲染器则使用不同的约定。如果链接失败，请检查目的地生成的实际标题标识符，而不是重复更改可见标签。考虑使重复标题更具描述性，例如“混淆示例”和“抽样错误示例”，这也可以改善读者的导航。重命名或重新排序部分后重新生成内容列表，然后再次测试。内容列表是一个维护的导航辅助工具，而不是在第一次导出后可以安全地忘记的结构的独立副本。

解释审查估计

字数除以标称审阅速度即可得出粗略的持续时间。密集的方程、图表和不熟悉的概念可能需要更长的时间。使用实际的学习课程来校准期望。

将报告的审核持续时间视为初始规划估计。一千字的熟悉的摘要散文和一千字的推论并不需要同样的关注。在一次真正的复习中安排一个明确的任务，例如在不查看和检查结果的情况下回答部分问题。将持续时间与估计值进行比较，并注意它们为何不同。如果数字或外部参考资料很重要，请包括检查它们所需的时间。字数统计可以帮助识别意外长的部分，但减少字数并不会自动带来改进。仅当剩余笔记仍然支持您期望用它完成的工作时，才保留重建推理所需的解释并删除多余的重复。

保留参考文献

将链接或书目详细信息保留在依赖于来源的声明附近。当两个读数不一致时，组织精美但没有出处的笔记很难验证。

在每个可能需要检查的声明附近放置一个来源参考，而不是在底部收集一堆无法解释的链接。当源较长时，请包含页面或部分定位符。清楚标记直接引用并保留其措辞；单独写下你的解释，这样编辑后两者就不会变得无法区分。当两种阅读不一致时，记录下不同的上下文或定义，而不是默默地将它们合并成一个陈述。在共享注释之前测试链接，并保留足够的书目信息，以便在链接稍后发生更改时识别来源。干净的 Markdown 文件很容易复制，这使得可追踪的归属以及将源声明与个人结论仔细分离在重复修改时特别有用。

刻意出口

在关闭浏览器之前保存 Markdown 文件。在进行大规模清理之前保留备份。如果与不使用 Markdown 的读者分享，也请提供合适的渲染或纯文本版本。

使用描述性文件名保存完成的源代码，然后从磁盘重新打开它以验证它是否确实已下载。在对标题结构或术语进行广泛更改之前，请保留一份过时的备份。如果共享渲染版本，请在目标查看器中检查它并确认表格、代码和链接仍然可用。当协作者需要修改时提供可编辑的源代码，并在不使用 Markdown 时提供可读的替代方案。避免假设完美的视觉导出可以自动访问；有意义的标题和图像的文本替代仍然需要注意。通过一个小的学习操作结束工作流程，例如回答某个部分下的问题，以便清理后的文档成为工作资源，而不是另一个未经审阅的文件。

可复制的规划模板

主题：用 Markdown 做学习笔记
来源和日期：
我需要回忆或做的事情：
第一次尝试没有注释：
错误或不确定性：
更正及支持来源：
下一步审查或行动：

Markdown 笔记清理器的输入示例：
#细胞生物学
* 膜
##交通
- 扩散遵循梯度。

常见问题

Markdown 清理是否会验证我笔记中的事实？

不会。它规范了文档结构并提供导航帮助。在依赖清理后的输出之前，请自行对照来源检查解释、参考文献和方程式。

如何防止文字代码成为标题？

将代码放入围栏块中并预览清理后的结果。清理器应保留代码内容；当格式化有意义时，保留原始副本。