本文是写作规范。写新文章时参照此格式,保证页面、列表、RSS 都能正常显示。

frontmatter 字段

每篇文章开头必须有 --- 包裹的元数据:

---
title: 文章标题
description: 一句话摘要(列表页和 SEO 使用)
pubDate: 2026-08-05
updatedDate: 2026-08-06 # 可选,文章更新时加上
tags: ["标签1", "标签2"] # 可选
draft: false # 可选,true 时文章不发布
---
字段 必填 说明
title 文章标题
description 摘要,用于列表页和搜索引擎
pubDate 发布日期
updatedDate 更新日期,会显示“更新于”
tags 标签数组
draft 设为 true 时文章不在站点出现(草稿)

草稿功能

写了一半的文章把 draft: true,站点不会显示它。写完改回 false 即可。

Markdown 写作要点

代码块

def hello(name: str) -> str:
    return f"Hello, {name}!"

引用

引用会以这种方式显示。

列表

  • 无序列表项
  • 另一个列表项
  1. 有序列表第一项
  2. 有序列表第二项

标题层级

## 是二级标题,### 是三级标题。目录(TOC)会自动从 ##### 生成,所以标题要按层级写,不要跳级。

其他说明

  • 文件名即 URL 后缀,用英文或拼音命名(如 writing-guide.md 对应 /blog/writing-guide/
  • 图片放在 src/assets/public/,大图注意压缩
  • 发布:git push 后自动部署,等几分钟访问即可