写作格式备忘

每次隔一阵子再写，我都会忘记开头那几行该怎么填。干脆记在这里，自己查起来方便，顺便也当作这个站支持哪些写法的清单。

文件放哪儿

一篇文章就是 src/content/writing/ 下的一个 Markdown 文件，文件名就是网址：my-first-post.md 会发布到 /writing/my-first-post/。

我的习惯是用小写英文加连字符。发布以后不要改名：旧链接会失效，评论也会跟着对不上。

开头的字段

---
title: 文章标题           # 必填
description: 一句话摘要   # 必填，显示在列表和分享卡片里
date: 2026-10-01          # 必填，发布日期
updated: 2026-10-05       # 可选，更新日期，会显示在标题栏里
category: 技术            # 可选，栏目：一篇文章只属于一个
tags: [技术, 笔记]        # 可选，标签：可以有多个
cover: ./images/cover.jpg # 可选，封面图，显示在正文最上方和分享卡片里
coverAlt: 封面图的文字说明 # 可选
comments: false           # 可选，关闭这一篇的评论
draft: true               # 可选，草稿只在本地预览中显示
---

填错了也不用怕。漏了标题、日期格式不对，构建会直接报错，告诉我是哪个文件；有问题的页面发不出去。

图片

我把图片放在文章旁边，用相对路径引用，构建时会自动压缩：

![图片说明](./images/cover.jpg)

正文里的图片点一下可以放大。

数学公式

行内公式用一对 $ 包起来，独占一行的用 $$：

质能方程 $E = mc^2$ 是行内公式。

$$
\int_0^1 x^2 \, dx = \frac{1}{3}
$$

图表

把代码块的语言写成 mermaid，就会画成图：

```mermaid
flowchart LR
  写作 --> 推送 --> 发布
```

视频和音乐

嵌视频和音乐要用到组件，所以我得把文件扩展名从 .md 改成 .mdx，其余写法不变：

<Bilibili id="BV 号" />

<Music id="网易云歌曲 ID" />

<Music src="/audio/demo.mp3" title="自己的音频文件" />

随记

随记不用标题，放在 src/content/notes/，开头只要一个时间：

---
date: '2026-10-04 21:30'  # 北京时间
tags: [生活]              # 可选
---

时间一定要加引号，而且不带秒。不加引号又带了秒的话，线上显示出来会差八个小时。