Skip to content

写作规范

推荐目录

text
docs/
  papers/       # 论文阅读笔记
  ideas/        # 未成熟想法和问题
  projects/     # 项目进展、实验计划、会议记录
  methods/      # 方法、模型、算法和工具
  datasets/     # 数据集和 benchmark 记录
  notes/        # 原子概念笔记
  public/       # PDF、图片、补充材料等静态附件

支持 Obsidian 风格链接:

  • [[papers/example-paper-note]]
  • [[papers/example-paper-note|示例论文]]
  • [[contrastive learning]]

不带目录的裸链接默认跳到 /notes/,适合先快速捕捉概念,再慢慢整理。

论文笔记文件名

推荐格式:

text
docs/papers/2026-firstauthor-short-title.md

例如:

text
docs/papers/2026-smith-efficient-retrieval.md

PDF 和附件

PDF 不建议直接放在 papers/ 目录下。推荐放在:

text
docs/public/pdfs/papers/

部署后可以通过 /pdfs/papers/<file>.pdf 访问。Markdown 页面里可以同时放在线预览和下载链接。

本地工作流

  1. 写 Markdown 笔记。
  2. 必要时把 PDF 或图片放到 docs/public/
  3. 更新 docs/.vitepress/config.ts 的 sidebar。
  4. 运行 npm run dev 本地预览。
  5. 运行 npm run build 检查构建。
  6. commit 并 push,Cloudflare Pages 自动部署。

Static research notes built with VitePress and KaTeX.