提示框參考

本頁面是 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

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

塊級公式：