本文档展示了 Shiroi 博客系统支持的所有 Markdown 格式,每个功能都包含代码和效果两部分。
一、基础文本格式
粗体
粗体文本 和 另一种粗体
斜体
斜体文本 和 另一种斜体
粗斜体
粗斜体文本
删除线(GFM)
删除线文本
行内代码
这是 行内代码 示例
二、Shiroi 自定义行内语法
剧透/隐藏文本(Spoiler)
悬停鼠标才能看到内容。
这是一段包含 剧透内容,鼠标悬停可见 的文字。
高亮标记(Mark)
这是一段 被高亮标记 的文字。
插入文本 / 下划线(Insert)
这是一段 被插入的文本 。
社交平台 Mention
支持 GitHub(GH)、Twitter(TW)、Telegram(TG)三种平台。
三、标题(H1 - H6)
标题会自动生成锚点链接,支持中文字符的 slug。
(标题效果见本文档各章节)
四、列表
无序列表
- 第一项
- 嵌套 1.1
- 嵌套 1.2
- 第二项
- 第三项
有序列表
- 第一步
- 第二步
- 子步骤 2.1
- 子步骤 2.2
- 子步骤 2.2.1
- 第三步
GFM 任务列表
- 未完成的任务
- 已完成的任务
- 另一个待办事项
五、链接与图片
普通链接
自动链接
图片
一张自然风光图片
六、引用
普通引用
这是一段普通的引用文本。
嵌套引用也是支持的。
GFM Alerts(GitHub 风格警告框)
注意:相邻的多个 Alert 之间需要用 <div /> 分隔,否则会被合并为一个引用块。
[!NOTE] 这是一条注意信息,用于补充说明用户应该了解的内容。
Tip这是一条提示信息,提供更好的操作建议。
Important这是一条重要信息,用户需要知道以达成目标。
Warning这是一条警告信息,需要用户立即注意以避免问题。
Caution这是一条危险信息,提醒某些操作的风险或负面后果。
七、表格(GFM)
| 功能 | 语法 | 说明 |
|---|---|---|
| 粗体 | **text** | 加粗显示 |
| 斜体 | *text* | 倾斜显示 |
| 高亮 | ==text== | 标记高亮 |
| 插入 | ++text++ | 下划线 |
八、代码块(Shiki 高亮)
支持 200+ 种语言的语法高亮,使用 GitHub Light/Dark 主题。
TypeScript
JSX/TSX
Diff 标记
九、数学公式(KaTeX)
行内公式
爱因斯坦质能方程:$ E = mc^2 $
二次方程求根公式:$x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}$
多项式:$P(x) = anx^n+a{n-1}x^{n-1} + \dots + a1x + a0$
块级公式
十、脚注(GFM Footnotes)
脚注支持交互式弹出预览,点击可跳转到脚注定义处。
这是一段包含脚注的文本[^1],还有另一个脚注[^note]。
十一、容器块(::: 语法)
警告/提示容器
支持类型:info、warning、error、success、note(等同 info)、danger(等同 error)。
info。error。Banner 容器
类型通过花括号参数指定:{warn}、{error}、{info}、{success}。
图片轮播(Gallery / Carousel)
支持 Markdown 图片语法和直接 URL 两种写法,gallery 和 carousel 效果相同。
网格布局(Grid)
参数:cols(列数)、gap(间距,默认 8)、rows(行数)、type(normal 或 images)。
Grid 第一格
Grid 第二格
Grid 第三格
图片网格(Grid type=images)
瀑布流布局(Masonry)
参数:gap(间距,默认 8)。响应式自动调整列数。
十二、富链接(Rich Link)自动嵌入
独立行的 URL 会被自动识别并渲染为富卡片或嵌入内容,无需任何额外语法。
GitHub 仓库卡片
GitHub Commit
GitHub PR
GitHub Issue
GitHub 文件预览(含代码行高亮)
GitHub Gist 嵌入
https://gist.github.com/Innei/94b3e8f078d29e1820813a24a3d8b04e
YouTube 视频嵌入
Twitter/X 推文嵌入
Bilibili 视频嵌入
CodeSandbox 嵌入
普通外部链接(自动预览卡片)
未匹配到特定平台的 URL 会尝试通过插件匹配,渲染为通用链接预览卡片。
https://trpc.io/docs/client/react/useInfiniteQuery
行内链接(不会变为卡片)
当 URL 不是独立成行,而是在段落中间时,不会被渲染为卡片,而是普通链接。
Inline Innei
Inline https://github.com/Innei
十三、LinkCard 组件
使用自定义 HTML 标签手动创建链接卡片,可精确控制来源和 ID。
GitHub 仓库卡片
GitHub Commit 卡片
站内文章卡片
所有支持的 source 类型
十四、Tabs 选项卡
React 是一个用于构建用户界面的 JavaScript 库。
十五、折叠面板(Details / Summary)
支持动画展开/折叠,打印时自动展开。
十六、视频
十七、特殊代码块
Mermaid 流程图
flowchart TD
A[开始] --> B{条件判断}
B -->|是| C[执行操作]
B -->|否| D[跳过]
C --> E[结束]
D --> E
Excalidraw 白板
Excalidraw 的剪贴板 JSON 数据可以直接粘贴到代码块中渲染。
远程 React 组件渲染
通过 CDN 加载远程 React 组件并渲染到页面中。
十八、分隔线
三种写法效果相同:
十九、HTML 行内元素
上标
x2 + y2 = z2
下标
H2O 是水的化学式
二十、格式速查表
| 分类 | 语法 | 说明 |
|---|---|---|
| 标准 Markdown | **粗体** | 加粗 |
*斜体* | 斜体 | |
`代码` | 行内代码 | |
> 引用 | 引用块 | |
[文本](url) | 链接 | |
 | 图片 | |
--- | 分隔线 | |
| GFM 扩展 | ~~删除线~~ | 删除线 |
- [x] 任务 | 任务列表 | |
| 表格 | | 表格 | |
[^1] | 脚注 | |
> [!NOTE] | GitHub Alert | |
| Shiroi 扩展 | ||剧透|| | 悬停显示 |
==高亮== | 文本标记 | |
++插入++ | 下划线/插入 | |
{GH@user} | 社交 Mention | |
| 数学公式 | $ 行内公式 $ | KaTeX 行内 |
$$ 块级公式 $$ | KaTeX 块级 | |
| 容器块 | ::: info/warning/error/success | 提示容器 |
::: banner {type} | Banner 横幅 | |
::: gallery / ::: carousel | 图片轮播 | |
::: grid {cols=N,gap=N} | 网格布局 | |
::: grid {type=images} | 图片网格 | |
::: masonry {gap=N} | 瀑布流布局 | |
| 自定义组件 | <LinkCard source="" id=""> | 链接卡片(13 种 source) |
<Tabs><Tab label=""> | 选项卡 | |
<details><summary> | 折叠面板 | |
<Video src=""> | 视频播放 | |
| 特殊代码块 | `mermaid | Mermaid 图表 |
`excalidraw | Excalidraw 白板 | |
`component | 远程 React 组件 | |
| 富链接 | 独立行 URL | 自动嵌入卡片 |