文档库

返回

这是一篇格式说明,覆盖本文件库目前支持的 Markdown 语法和可嵌套组件。
在 Pages CMS 里写文章时,可以直接复制本文的写法。

一、文本格式#

普通段落直接换行书写即可。支持:

  • 粗体
  • 斜体
  • 删除线
  • 行内代码
  • 普通链接 ↗
  • 键盘按键:Ctrl + C
  • 高亮文本:重点内容

段落之间空一行。中文排版不需要手动加空格,浏览器会自动处理。

二、标题层级#

# 一级标题(文章正文里通常不用,标题已由 frontmatter 生成)
## 二级标题
### 三级标题
#### 四级标题
markdown

文章页面右侧的“目录”会自动读取二、三级标题。

三、列表与嵌套#

无序列表#

  • 第一层
    • 第二层
      • 第三层
  • 回到第一层

有序列表#

  1. 第一步
  2. 第二步
    1. 子步骤
    2. 另一个子步骤
  3. 第三步

任务列表#

  • 已完成事项
  • 未完成事项

列表里嵌套代码#

  • 安装依赖:

    npm install
    bash
  • 启动开发服务器:

    npm run dev
    bash

四、引用与嵌套引用#

一级引用。

二级引用,可以继续嵌套。

回到一级引用:

  • 引用里也可以放列表
  • 也可以放 行内代码

五、代码块#

基础代码块#

const message = 'hello'
console.log(message)
js

带标题的代码块#

src/config.ts
export const site = {
  title: '文档库'
}
js

带高亮标记的代码#

const name = '文档库'
ts

六、表格#

格式 写法 说明
粗体 **文字** 强调
斜体 *文字* 语气
代码 `code` 行内代码
链接 [文字](https://example.com) 跳转

表格里也可以使用 粗体、行内代码 和 链接 ↗。

七、链接与图片#

普通链接:Astro 官网 ↗

图片:

文档库分享卡片

图片使用 /images/文件名 这样的站内绝对路径;在 Pages CMS 上传后会自动进入 public/images/。

八、分隔线#


九、数学公式#

行内公式:E=mc2E = mc^2

块级公式:

∫abf(x) dx=F(b)−F(a)\int_{a}^{b} f(x)\,\mathrm{d}x = F(b) - F(a)

十、脚注#

这是一个带脚注的句子1。

十一、提示框#

十二、标签页(可嵌套)#

这是 Markdown 标签页。

  • 支持列表
  • 支持 行内代码
npm run build
bash

十三、步骤条#

  1. 打开 Pages CMS
  2. 新建文章并填写字段
  3. 保存后触发构建

十四、折叠面板#

点开查看折叠内容

这里可以放较长的说明。

  • 折叠内容里的列表
  • 折叠内容里的 代码
console.log('inside collapse')
js

十五、剧透文本#

这是一个 被隐藏的剧透内容 ,鼠标移上去才会显示。

十六、时间线#

  • 2026-01-01
    创建文档库。
  • 2026-02-01
    增加第一篇文章。
  • 2026-03-01
    完善写作格式说明。

十七、卡片#

卡片标题

卡片副标题

2026-11-11

卡片正文可以放少量说明文字。

十八、嵌套组合#

下面把列表、引用、代码块和提示框组合在一起:

  1. 先创建一个目录:

    mkdir demo
    bash
  2. 然后进入目录:

    注意:路径要写对。

  3. 最后确认结果:

十九、写作字段#

字段 说明
标题 文章标题,最多 60 字
发布日期 YYYY-MM-DD
描述 列表与 SEO 摘要,最多 160 字
自定义链接 决定文章 URL,例如 guide/writing
标签 可多个,用于标签筛选
草稿 打开后正式构建不发布
置顶 在列表中优先显示
正文 本文内容

提示:slug 只使用小写字母、数字、连字符和 /。
不要用 blog、about、archives、tags、search 作为第一段。

Footnotes#

  1. 脚注内容会显示在文章底部。 ↩

文章格式说明
https://doc.gezhibuge.com/guide/writing
作者 鸽纸不鸽
发布于 2026年11月11日

未经特别说明,本文采用 CC BY-NC-SA 4.0 许可协议