深色模式
Markdown:让笔记更容易回看
建站演示文章:用于展示本站的内容与排版,可按需要替换为自己的笔记。
先写要解决的问题
一篇笔记不必覆盖整个主题。可以从一句话开始:“当代码块太长时,怎样让读者先看到关键部分?”标题负责告诉读者主题,开头负责解释适用场景。
推荐保留三级结构:一级标题是文章名,二级标题是步骤或问题,三级标题补充局部细节。标题太碎时,先试着合并内容。
用代码展示最小例子
ts
const note = {
title: '今天记下的一个问题',
status: 'draft',
}
function publish(title: string) {
return title.trim()
}示例只保留解释所需的字段。实际配置与示例不同时,应写明差异。
给未来的自己留提示
比起“这里要注意”,更有用的写法是“路径区分大小写,发布前检查图片文件名”。
把步骤画出来
下面的流程图演示从问题到笔记的基本过程:
流程图加载中…
查看流程图源码
flowchart LR A[记录问题] --> B[整理最小例子] B --> C[验证结果] C --> D[写下结论] D --> E[留好检索入口]
发布前读一遍
检查标题是否说明主题、代码能否独立理解、图片是否有说明、链接是否指向正确页面。删除一段内容后文章仍然完整,通常意味着那一段可以缩短。
继续阅读:阅读笔记的整理方法。