本文档汇总了 Blog 博客系统支持的所有文章功能特性,并提供实时渲染的使用示例。
1. Alert 提示框
提供五种预设提示框样式,用于在文章中展示不同级别的提示信息。
单行内容
语法::::note / :::tip / :::important / :::warning / :::caution 配合 ::: 闭合。
以下是五种提示框的实时渲染效果:
这是一个提示。
这是一个建议。
这是一个重要事项。
这是一个警告。
这是一个危险事项。
多行内容
提示框内支持多段落、列表、粗体等 Markdown 元素:
这是一个包含多行内容的提示框。
- 支持列表项
- 可以包含多个段落
重点内容:还可以包含粗体文字和其他 Markdown 元素。
嵌套内容
提示框内可以嵌入代码块等复杂元素:
提示框内可以包含代码块等其他元素。
console.log('Hello World');自定义标题
使用 :::important[自定义标题] 语法覆盖默认标题:
这是一个带有自定义标题的提示框。标题会显示为”自定义标题”而不是默认的”IMPORTANT”。
2. 嵌入式卡片
支持在文章中嵌入第三方平台的内容卡片,丰富文章表现形式。
音乐卡片
语法:::music{id="歌曲ID"}
GitHub 卡片
语法:::github{repo="owner/repo"}
3. 草稿管理
提供文章草稿状态控制功能,方便作者进行内容预览和迭代。
在文章 frontmatter 中设置 draft: true 即可将文章设为草稿:
- 环境隔离:草稿文章仅在
dev环境下可见,生产环境自动隐藏 - 视觉标识:草稿文章顶部显示红色提示框,内容为”草稿警告:此文章为草稿,只出现在测试环境,生产环境将不会显示。“
4. KaTeX 数学公式
全面支持 KaTeX 数学公式渲染,覆盖学术写作中的常见公式类型。
行内公式
这是一个行内公式示例:,它展示了爱因斯坦的质能方程。
另一个行内公式示例:,表示对 n 个数求和。
块级公式
薛定谔方程(时间依赖形式):
多行对齐公式
麦克斯韦方程组(微分形式):
矩阵
分段函数
极限
积分
高斯积分:
5. 特殊排版样式
提供多种自定义 Markdown 扩展语法,增强文章表现力。
5.1 引用块
使用 :::quote ... ::: 语法创建精美引用块,支持 HTML 标签对齐引文出处:
引用块内也可以嵌入数学公式:
5.2 模糊效果
语法:!!文本!!
这是一个模糊效果。
- 桌面端:鼠标悬停移除模糊,点击后保持 3 秒清晰显示
- 移动端:点击移除模糊,当同时满足点击后超过 3 秒和页面滑动才会变为模糊状态
5.3 拼音标注
语法:{汉字}(拼音),用 | 分隔每个字的拼音,用 || 跳过某个字的注音。
拼音
君の名は
5.4 彩虹文字
语法:==文本==
这是一个彩虹文字效果。
5.5 下划线
语法:++文本++
这个文字下面有下划线效果。
5.6 样式嵌套
上述特殊样式可以自由嵌套组合,例如模糊 + 彩虹 + 拼音:
这是一个模糊并且带拼音的彩虹
另一个嵌套示例:
Do you like the movie 君の名は
5.7 脚注
在文章正文中使用 [^1] 添加脚注引用,在文末定义对应的引用内容1。
这是另一句话,引用了另外一个文献2。
5.8 Typst 渲染
基于 Typst.ts 实现 Typst 排版渲染。
基本排版示例:
Cetz 3D 图形示例:
注意:暗色模式下 Typst 图形渲染效果可能不佳。
6. 文章目录生成
根据文章标题层级自动生成可导航的目录(Table of Contents)。
- 自动解析
##、###、####等各级标题 - 支持无限层级嵌套
- 生成可点击跳转的目录链接
- 在
src/config.ts中可通过toc.depth配置最大目录深度(1~4)
7. 外部视频嵌入
支持通过标准 HTML <iframe> 标签嵌入外部平台的视频播放器,自适应宽度(width="100%")。
功能总览
| 功能 | 语法 | 核心能力 |
|---|---|---|
| Alert 提示框 | :::type ... ::: | 5 种预设样式,支持嵌套与自定义标题 |
| 音乐卡片 | ::music{id="..."} | 网易云音乐嵌入 |
| GitHub 卡片 | ::github{repo="..."} | 仓库信息卡嵌入 |
| 草稿管理 | frontmatter draft: true | 环境隔离 + 视觉标识 |
| KaTeX 行内公式 | $...$ | 行内数学公式 |
| KaTeX 块级公式 | $$...$$ | 居中块级数学公式 |
| 引用块 | :::quote ... ::: | 精美引用,支持出处对齐和内嵌公式 |
| 模糊效果 | !!...!! | 悬停/点击交互式模糊 |
| 拼音标注 | {汉字}(拼音) | 中日文注音 |
| 彩虹文字 | ==...== | 渐变色彩 |
| 下划线 | ++...++ | 文字下划线 |
| 样式嵌套 | 组合使用 | 多种效果自由叠加 |
| 脚注 | [^n] | 文内引用 + 文末定义 |
| Typst 渲染 | ```typst | 排版与 3D 图形渲染 |
| 目录生成 | 自动 | 基于标题层级自动生成 |
| 视频嵌入 | <iframe> | 跨平台视频嵌入 |