From 9110357574f673f9930dabc5940c65e28d3c1903 Mon Sep 17 00:00:00 2001
From: Ryan Wang <i@ryanc.cc>
Date: Fri, 8 Dec 2023 16:04:09 +0800
Subject: [PATCH] docs: add documentation for theme error template (#287)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

添加主题错误模板的文档。

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/144


```release-note
None
```
---
 .../theme/template-variables/error.md         | 45 +++++++++++++++++++
 sidebars.js                                   |  1 +
 .../theme/template-variables/error.md         | 45 +++++++++++++++++++
 versioned_sidebars/version-2.11-sidebars.json |  3 +-
 4 files changed, 93 insertions(+), 1 deletion(-)
 create mode 100644 docs/developer-guide/theme/template-variables/error.md
 create mode 100644 versioned_docs/version-2.11/developer-guide/theme/template-variables/error.md

diff --git a/docs/developer-guide/theme/template-variables/error.md b/docs/developer-guide/theme/template-variables/error.md
new file mode 100644
index 0000000..4f99aeb
--- /dev/null
+++ b/docs/developer-guide/theme/template-variables/error.md
@@ -0,0 +1,45 @@
+---
+title: 错误页面
+description: 关于错误页面的模板变量
+---
+
+## 路由信息
+
+- 模板路径：`/templates/error/{404,4xx,500,5xx,error}.html`
+- 访问路径：无固定访问路径，由异常决定
+
+:::info 提示
+错误页面的可使用模板由状态码决定，例如 404 状态码对应的模板为 `/templates/error/404.html` 或者 `/templates/error/4xx.html`。也可以使用 `/templates/error/error.html` 作为默认模板。
+
+识别顺序如下：
+
+1. `/templates/error/404.html`
+2. `/templates/error/4xx.html`
+3. `/templates/error/error.html`
+:::
+
+## 变量
+
+### error
+
+#### 变量类型
+
+```json
+{
+  "detail": "string",                     // 异常详细信息
+  "instance": "string",                   // 异常实例
+  "status": "number",                     // 异常状态码
+  "title": "string",                      // 异常标题
+  "type": "string"                        // 异常类型
+}
+```
+
+#### 示例
+
+```html title="/templates/error/error.html"
+<div>
+  <h2 th:text="${error.status}"></h2>
+  <p th:text="${#strings.defaultString(error.title, 'Internal server error')}"></p>
+  <p th:if="${not #strings.isEmpty(error.detail)}" th:text="${error.detail}"></p>
+</div>
+```
diff --git a/sidebars.js b/sidebars.js
index 67f6100..e1e3435 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -179,6 +179,7 @@ module.exports = {
                 "developer-guide/theme/template-variables/categories",
                 "developer-guide/theme/template-variables/category",
                 "developer-guide/theme/template-variables/author",
+                "developer-guide/theme/template-variables/error",
               ],
             },
             {
diff --git a/versioned_docs/version-2.11/developer-guide/theme/template-variables/error.md b/versioned_docs/version-2.11/developer-guide/theme/template-variables/error.md
new file mode 100644
index 0000000..4f99aeb
--- /dev/null
+++ b/versioned_docs/version-2.11/developer-guide/theme/template-variables/error.md
@@ -0,0 +1,45 @@
+---
+title: 错误页面
+description: 关于错误页面的模板变量
+---
+
+## 路由信息
+
+- 模板路径：`/templates/error/{404,4xx,500,5xx,error}.html`
+- 访问路径：无固定访问路径，由异常决定
+
+:::info 提示
+错误页面的可使用模板由状态码决定，例如 404 状态码对应的模板为 `/templates/error/404.html` 或者 `/templates/error/4xx.html`。也可以使用 `/templates/error/error.html` 作为默认模板。
+
+识别顺序如下：
+
+1. `/templates/error/404.html`
+2. `/templates/error/4xx.html`
+3. `/templates/error/error.html`
+:::
+
+## 变量
+
+### error
+
+#### 变量类型
+
+```json
+{
+  "detail": "string",                     // 异常详细信息
+  "instance": "string",                   // 异常实例
+  "status": "number",                     // 异常状态码
+  "title": "string",                      // 异常标题
+  "type": "string"                        // 异常类型
+}
+```
+
+#### 示例
+
+```html title="/templates/error/error.html"
+<div>
+  <h2 th:text="${error.status}"></h2>
+  <p th:text="${#strings.defaultString(error.title, 'Internal server error')}"></p>
+  <p th:if="${not #strings.isEmpty(error.detail)}" th:text="${error.detail}"></p>
+</div>
+```
diff --git a/versioned_sidebars/version-2.11-sidebars.json b/versioned_sidebars/version-2.11-sidebars.json
index d600748..a10f705 100644
--- a/versioned_sidebars/version-2.11-sidebars.json
+++ b/versioned_sidebars/version-2.11-sidebars.json
@@ -160,7 +160,8 @@
                 "developer-guide/theme/template-variables/tag",
                 "developer-guide/theme/template-variables/categories",
                 "developer-guide/theme/template-variables/category",
-                "developer-guide/theme/template-variables/author"
+                "developer-guide/theme/template-variables/author",
+                "developer-guide/theme/template-variables/error"
               ]
             },
             {