Skip to content

内容写作流程

为了把维护成本压低,这个站点建议长期使用同一套新增内容流程。

1. 先决定最终分类

新内容直接放进最终目录,不先堆到临时区。

常用一级目录:

  • /00-前端/
  • /01-软件/
  • /02-操作系统/
  • /03-知识库/
  • /04-职业成长/
  • /05-备忘录/

2. 复制模板

普通文章复制 docs/.templates/article.md
新建分区入口页复制 docs/.templates/section-index.md

3. 只填最小 frontmatter

优先保证这几个字段:

  • title
  • description
  • date

4. 文件名保持稳定

文件名应尽量描述主题,不要使用模糊命名,例如:

  • vitepress-cloudflare-pages.md
  • macos-terminal-fonts.md
  • government-procurement-basics.md

避免:

  • note1.md
  • test.md
  • 经验总结.md

5. 一页只解决一个主要问题

如果一篇内容明显拆成两个独立主题,就拆成两页。这样后面索引、搜索和维护都更清晰。

6. 写完后本地看一眼

新增内容后至少跑一次:

bash
npm run docs:dev

确认:

  • 标题是否自然
  • 描述是否适合列表页展示
  • 目录位置是否合适

山与海都很美,努力走出去