这是一篇示例文章,用于展示内容与排版。
先告诉读者这是什么
好的笔记首先说明它回答的问题。标题尽量具体,第一段交代背景,后面的内容围绕同一个主题展开。
比如,把“今天的学习”改成“如何用 Markdown 整理技术笔记”,未来的自己会更容易知道这篇内容有什么用。
用表格比较,用列表组织
表格适合比较同一组维度,列表适合表达并列内容或连续步骤。
| 内容类型 | 推荐表达 | 读者可以得到什么 |
|---|---|---|
| 几种方案的区别 | 表格 | 一眼看到取舍 |
| 操作顺序 | 有序列表 | 按步骤重复过程 |
| 一组注意事项 | 无序列表 | 快速检查重点 |
| 一个完整想法 | 段落 | 理解背景和理由 |
为代码保留上下文
代码不只需要正确,也需要告诉读者输入是什么、输出是什么,以及它为什么这样写。
type Note = { title: string; published: boolean };
const notes: Note[] = [
{ title: '一篇可以公开的笔记', published: true },
{ title: '还在整理中的想法', published: false },
];
const publishedNotes = notes.filter((note) => note.published);
console.log(publishedNotes.map((note) => note.title));
行内代码适合短字段,如 title、published;完整示例放进代码块,并标注语言。
数学公式也可以清楚地表达
行内公式可以自然地出现在段落中,例如 。较长的表达式单独放在一行:
对于两组集合的相似程度,可以用交集与并集的比例来表示:
先说明变量和概念,再给出公式,比单独堆叠符号更容易理解。公式比较宽时,应当在自己的区域内滚动,而不把整个页面撑开。
留一个重新阅读的入口
稳定的文章地址、合适的分类和少量有意义的标签,都能帮助未来的自己再次找到它。
写完之后,可以做一个简单检查:如果一个月后的自己第一次打开这篇笔记,是否还能知道它解决什么问题、如何重复其中的步骤?