跳到主要内容

笔记规范

vps4128
发布日期:
1 分钟阅读
编辑此文

目录

展开目录

目录结构

src/data/blog/
├── start/             # 使用与写作规范
├── tech/              # 技术笔记
├── tools/             # 工具手册
└── reading/           # 读书与思考

新增主题时优先放进已有目录;一个目录下超过 15 篇再考虑拆分。URL 会带上目录名,例如 tech/foo.md 对应 /posts/tech/foo/。

Frontmatter 约定

---
title: 用 Starlight 搭建知识库
description: 一句话说明这篇笔记解决什么问题。
pubDatetime: 2026-11-02T00:00:00+08:00
tags: ["astro", "starlight"]
---

写作原则

  1. 一篇笔记只解决一个问题。 主题太大就拆成系列,用链接串起来。
  2. 结论先行。 开头两三句话说明适用场景和最终结论,再接细节。
  3. 代码块标注语言,并尽量给出完整可运行的命令或配置。
  4. 记录环境与版本。 尤其是排错笔记,缺少版本信息时结论很容易过期。
  5. 链接到相关笔记。 知识库的价值在于页面之间的关联,而不是单篇的完整。

命名

Previous
用 Starlight 搭建可检索的知识库
Next
终端与 Git 常用命令