这是一篇自用的语法速查,覆盖这个博客(Hexo +
Stellar 主题)实际支持的排版能力。
写文章时对照抄即可,不确定效果的部分都给了可运行的例子。
发布新文章
标准 Hexo 流程是四条命令:
1 | # 1. 新建文章 |
本仓库在此基础上用脚本封装了常用操作:
1 | # 新建草稿(不进构建产物,可本地预览) |
发布流程:把 _drafts/ 下的 .md 和同名资源文件夹一起移到 source/_posts/,
然后提交并推送——推送后由 Cloudflare Pages 自动构建发布。
文章的日期决定固定链接,格式是 /年/月/日/文件名/;改文件名等于改链接,
已有评论会跟着旧链接走,改名要谨慎。
标题层级
一级标题由文章标题自动生成,正文里从二级开始用:
1 | ## 二级标题 |
效果对照
四级标题示例
五级标题示例
六级标题示例
文本样式
粗体、斜体、粗斜体、删除线、行内代码。
转义特殊字符:*这不是斜体*。
需要强调时也可以用标签:
这是 mark 标签的高亮链接
行内链接、站内链接与引用式链接:
1 | [Hexo 官网](https://hexo.io/) |
自动链接:https://hexo.io/docs/。
列表
无序列表:
- 第一项
- 第二项
- 嵌套项
- 另一个嵌套项
- 第三项
有序列表:
- 第一步
- 第二步
- 第三步
任务列表(GFM 规范):
- 已完成的任务
- 未完成的任务
也可以改用主题标签,支持颜色与图标:
引用
普通引用:
这是一段引用文字。
引用里可以换段,也可以包含 加粗 和
代码。
带样式的引用块:
用 quot 标签做的引用,默认带引号图标
提示块
note 标签支持 8 种颜色(red / orange / yellow / green / cyan / blue / purple / gray):
这是一个 note 提示块,适合放补充说明。
绿色常用于「小技巧」类内容。
橙色适合「注意 / 提醒」。
红色适合「警告 / 不要这样做」。
tip 是悬停气泡:把鼠标移到这段文字这是气泡里显示的注解上看看。
折叠块
点我展开:折叠内容
折叠区里可以放任意 Markdown,例如列表:
- 列表项一
- 列表项二
以及代码:
1 | console.log('折叠块里的代码'); |
代码
行内代码用反引号:npm install。
围栏代码块会由 highlight.js 高亮,显示行号与语言,
右上角有复制按钮:
1 | // JavaScript 示例:把数组按长度分组 |
1 | # Python 示例:统计词频 |
1 | # Shell 示例 |
还有行内复制按钮:
表格
普通 Markdown 表格:
| 能力 | 是否支持 | 说明 |
|---|---|---|
| Markdown | 支持 | 标准语法 + GFM 扩展 |
| 代码高亮 | 支持 | highlight.js,带行号 |
| 数学公式 | 支持 | KaTeX,构建时渲染 |
| 图片灯箱 | 支持 | Fancybox,点击放大 |
| 表格横向滚动 | 支持 | 用 table 标签 |
内容较长时用 table 标签包裹,可横向滚动:
| 标签 | 用途 | 参数要点 |
|---|---|---|
note | 提示块 | color:颜色、标题、内容 |
folding | 折叠块 | color、open:true、标题 |
tabs | 选项卡 | 内容内用 tab 注释分隔 |
timeline | 时间线 | 内容内用 node 注释分隔 |
grid | 多列网格 | c:2 指定列数 |
图片与媒体
单张图片(点击可放大,灯箱用的是 Fancybox):
指定宽度的图片(image 标签):
图集(gallery 标签,支持 layout:grid 或 layout:flow、size、aspect_ratio):
视频与音频标签需要真实媒体文件,语法见文末速查。
数学公式
公式由 KaTeX 在构建时渲染成静态 HTML。
行内公式:质能方程 ,欧拉恒等式 。
行间(块级)公式:
选项卡
这是第一个标签页里的内容。
可以放任意 Markdown,比如 加粗 或列表:
- A
- B
这是第二个标签页。
1 | console.log('标签页里的代码'); |
时间线
重写这篇用法示例,补充发布流程与全部标签说明。
更新 Node 与依赖,修复安全告警。
把站点迁到本机 IIS,规避 Pages 缓存问题。
多列网格
左栏
可以写说明文字,也可以放小段代码。
右栏
两栏自动响应式,窄屏会堆叠。
表情与图标
系统 Unicode 表情可以直接用:😀 🎉 ✅ 🚀,由系统字体渲染,不需要额外资源。
主题还提供 emoji 与 icon 标签(emoji 依赖外部图床,加载可能不稳定,故此处不演示):
语法速查
以下是主题注册的全部标签(共 45 个),参数细节见
Stellar 标签文档。
| 分类 | 标签 | 说明 |
|---|---|---|
| 标注 | note | 彩色提示块:color:red + 标题 + 内容 |
| 标注 | tip | 悬停气泡:文字 + pop:注解 |
| 标注 | mark | 高亮文字:color:yellow |
| 标注 | quot / blockquote | 引用块 |
| 标注 | hashtag | 标签徽章:文字 + 目标地址 + color:blue |
| 标注 | button | 按钮:文字 + 目标地址 |
| 标注 | icon | 图标:default:documents 等 |
| 标注 | emoji | 表情图片,依赖外部图床 |
| 标注 | copy | 行内复制按钮 |
| 标注 | checkbox / radio | 复选 / 单选样式 |
| 布局 | tabs | 选项卡,内容用 tab 注释分隔 |
| 布局 | grid | 多列网格,c:2,内容用 cell 注释分隔 |
| 布局 | folding | 折叠块:color、open:true |
| 布局 | timeline | 时间线,内容用 node 注释分隔 |
| 布局 | navbar | 子页面导航栏 |
| 布局 | box / frame / dropdown | 盒子 / 边框 / 下拉容器 |
| 媒体 | image | 图片:路径 + 说明 + width:400px |
| 媒体 | gallery | 图集:layout / size / aspect_ratio |
| 媒体 | video / audio | 视频 / 音频,支持 bilibili、youtube、netease 参数 |
| 媒体 | swiper | 轮播图 |
| 媒体 | albums / folders / posters / reel | 相册型布局 |
| 数据 | table | 表格容器:style:scroll / wrap / compact |
| 数据 | toc | 目录 |
| 数据 | link | 卡片式链接:地址 + 标题 |
| 数据 | ghcard / gist | GitHub 卡片 / Gist 嵌入 |
| 数据 | friends / sites | 友链 / 站点列表,读取数据文件 |
| 数据 | rating / vote | 评分 / 投票,需要自建服务,当前未启用 |
| 阅读 | paper / poetry / reel | 论文 / 诗歌 / 卷轴排版 |
| 阅读 | chat | 对话气泡 |
| 其他 | md | 在标签里再渲染一小段 Markdown |
| 其他 | mbti / okr / banner | MBTI 图 / OKR 面板 / 横幅 |
目前未启用的能力
- Mermaid 图表:需要额外安装渲染插件,并在主题配置里把
features.diagrams.provider设为mermaid,详见
Mermaid 官网。 - 评分 / 投票:依赖外部评分服务地址,当前为空。
- GitHub 卡片:需要可用的接口地址。
评论区支持的格式
评论区由 Twikoo 提供,支持以下写法(与正文语法略有不同):
- Markdown:粗体、斜体、
删除线、行内代码、代码块(带语言高亮)、
列表、引用、链接、表格 - 数学公式:行内用单个美元符号,块级用双美元符号,浏览器端渲染
- 表情:面板里的 OwO 表情,会以冒号包裹的名称插入
- 图片:选择或直接粘贴上传,存储在自己的对象存储里
- 其他:草稿本地保存、预览、楼中楼回复、点赞、快捷键发送、人机验证
正文的公式用 katex 标签(构建时渲染),评论区的公式用美元符号(运行时渲染),
两者不要混用。