Skip to content

写作规范

文件组织

推荐按学科和课程主题组织:

text
docs/
  deep-learning/
  cv/
  nlp/
  math/
  notes/

notes/ 适合暂存还没归类的概念卡片。裸写 [[concept name]] 时,会自动跳到 /notes/concept-name

支持两种写法:

  • [[math/linear-algebra]]
  • [[math/linear-algebra|线性代数]]

如果目标文档还没创建,构建不会失败,方便先搭知识网络再补内容。

数学公式

行内公式使用单个美元符号:$a^2 + b^2 = c^2$

块公式使用双美元符号:

tex
$$
\nabla_\theta \mathcal{L}(\theta)
= \frac{1}{N}\sum_{i=1}^{N}\nabla_\theta \ell(f_\theta(x_i), y_i)
$$

新增文档流程

  1. 在对应目录创建 .md 文件。
  2. 给文档写一个一级标题。
  3. docs/.vitepress/config.tssidebar 中加入链接。
  4. 本地运行 npm run dev 预览。
  5. 推送到 GitHub,Cloudflare Pages 会自动部署。

Static academic notes built with VitePress and KaTeX.