提示框参考

本页面是 markdown 流水线所支持的全部提示框变体的参考手册。

提示框块

anote - 一般注释

📝快速提示

这是一个用于观察和补充说明的通用注释块。

info - 附加信息

💡专业提示

在本地化内容中引用资源时使用绝对路径。

todo - 任务提醒

✅待办事项

  • 为所有博客文章添加摘要
  • 校验标签大小写
  • 测试 Mermaid 图表

warning - 重要警告

⚠️重大变更

Hexo 8.x 要求 Node.js 14.0.0 或更高版本。升级前请先更新你的环境。

error - 严重问题

❌常见错误

请勿使用 note 类型 —— 它与 CSS 冲突。请始终使用 anote。

success - 积极结果

✅构建成功

站点已成功生成，可以部署。

tip - 最佳实践

💡性能优化

启用图片懒加载以提升页面加载速度。

question - 设计考量

🤔设计决策

我们应该使用 Git Flow 还是 GitHub Flow？

quote - 引用

💬Linus Torvalds

Talk is cheap. Show me the code.

其他提示框类型

以下类型具有相同的语法，但默认标题和图标不同：

danger - 严重危险

☠️危险操作

此操作不可逆，请格外谨慎。

attention - 请注意

⚠️请阅读

发送请求前请确认收件人地址。

caution - 小心

⚠️慢路径

该分支在大数据集上会执行全表扫描。

failure - 操作失败

❌测试套件

47 项测试中有 5 项失败，详情请见报告。

missing - 缺少必需输入

❌必填字段

配置对象中必须提供 apiKey 字段。

fail - 简明失败

❌构建失败

src/utils/parser.ts 中存在编译错误。

bug - 已知缺陷

🐛Issue #142

当表达式以 \( 开头时，行内公式无法渲染。

可折叠提示框

将 collapsible="+" 设置为默认展开，collapsible="-" 设置为默认折叠。

代码：

:::warning{title="点击展开" collapsible="-"}
仅在展开后才会显示的隐藏细节。
:::

:::info{title="默认展开" collapsible="+"}
本节默认展开。点击摘要可折叠。
:::

结果：

⚠️点击展开▼

仅在展开后才会显示的隐藏细节。

💡默认展开▼

本节默认展开。点击摘要可折叠。

指令标签标题语法

除了 title="..."，还可以将第一个子节点写成 [label] 来设置标题：

代码：

:::warning[v3 中的重大变更]
默认导出已被移除，请改用命名导出。
:::

结果：

⚠️v3 中的重大变更

默认导出已被移除，请改用命名导出。

提示框内的高级排版

列表嵌套

⚠️安全检查清单

部署前：

  1. 移除所有 API 密钥和密钥
  2. 启用 HTTPS
  3. 更新依赖
    • 检查漏洞
    • 运行 npm audit fix
  4. 在预发布环境中测试

引用嵌套

📝设计哲学

Simplicity is the ultimate sophistication. — Leonardo da Vinci 此原则同样适用于代码架构与用户界面设计。

混合内容

💻完整安装指南

步骤 1： 安装依赖 npm install hexo-cli -g 步骤 2： 创建新项目

  • 初始化：hexo init blog
  • 进入目录：cd blog
  • 安装依赖：npm install

步骤 3： 配置检查清单

  1. 更新 _config.yml
  2. 设置站点标题与描述
  3. 配置部署设置

注意： 在重大变更前请务必备份配置。

提示框内的代码区块

💡Git 配置

设置你的 Git 身份：

git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

提示框内的表格

💡端口范围

操作系统范围数量
Linux32768-6099928232
Windows49152-6553516384
macOS49152-6553516384

嵌套格式

❌常见陷阱

避免这些错误：

  1. 硬编码路径

    // ❌ 不好
const path = 'C:\\Users\\neo\\file.txt';
// ✅ 好
const path = require('path').join(__dirname, 'file.txt');

  2. 缺少错误处理

    • 总是使用 try-catch 块
    • 验证用户输入
    • 正确记录错误

  3. 忽略 async/await

    回调函数会导致”回调地狱”。使用现代异步模式。

提示框内的 LaTeX

LaTeX 公式也可以在提示框内渲染。这同时检验了提示框插件和 KaTeX 管道的协作。

代码：

:::info{title="提示框内的 LaTeX"}
行内公式：一元二次方程的求根公式是 $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$。

块级公式：

$$
\sum_{i=1}^{n} i^2 = \frac{n(n+1)(2n+1)}{6}
$$
:::

结果：

💡提示框内的 LaTeX

行内公式：一元二次方程的求根公式是 。

块级公式：