Atmoos

返回

笔记库 / 建站与配置

内容写作规范

记录文章、笔记、标签、摘要和草稿字段的基本约定。

内容类型#

本站目前分成两类内容:

  • 杂想文章:放在 src/content/blog,按发布时间展示。
  • 知识库笔记:放在 src/content/docs,按目录和排序展示。

杂想可以轻一点,笔记库要更结构化。

元信息约定#

每篇内容都应该尽量写清楚:

  • title:标题,直接说明主题。
  • description:一句话摘要,用于列表页和搜索结果。
  • publishDate:发布时间,杂想内容需要填写。
  • tags:标签,数量不用多,2 到 4 个足够。
  • draft:草稿内容设为 true,只用于本地预览。

写作方式#

一篇笔记只解决一个问题。推荐结构是:

  1. 先写这个问题是什么。
  2. 再写当前做法或判断。
  3. 最后补充下一步、参考资料或待验证点。

如果一篇内容开始变得很长,就拆成几篇互相链接的笔记。

当前路径:笔记库 / 建站与配置 / 内容写作规范

回到笔记库

笔记库

按主题维护的长期记录。