diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index f1d572ba..cf19c745 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -23,6 +23,10 @@ export default defineConfig({
link: '/',
activeMatch: '^/$|^/guide/'
},
+ { text: '社区项目',
+ link: '/case/index',
+ activeMatch: '^/case/'
+ },
{
text: '开发手册',
link: '/developer/index',
@@ -32,6 +36,7 @@ export default defineConfig({
sidebar: {
'/guide/': getGuideSidebarZhCN(),
+ '/case/': getCaseSidebarZhCN(),
'/developer/': getDeveloperSidebarZhCN(),
'/': getGuideSidebarZhCN()
},
@@ -45,12 +50,14 @@ export default defineConfig({
'/en_US/': {
label: 'English',
nav: [
- { text: 'User Guide', link: '/en_US/', activeMatch: '^/$|^/en_US/guide/' },
+ { text: 'User Guide', link: '/en_US/', activeMatch: '^/en_US/guide/' },
+ { text: 'Community Projects', link: '/en_US/case/index', activeMatch: '^/en_US/case/' },
{ text: 'Development Manual', link: '/en_US/developer/index', activeMatch: '^/en_US/developer/' }
],
sidebar: {
'/en_US/guide/': getGuideSidebarEnUS(),
+ '/en_US/case/': getCaseSidebarEnUS(),
'/en_US/developer/': getDeveloperSidebarEnUS(),
'/en_US/': getGuideSidebarEnUS()
},
@@ -107,6 +114,18 @@ function getGuideSidebarZhCN() {
]
}
+function getCaseSidebarZhCN() {
+ return [
+ {
+ text: '社区项目',
+ children: [
+ { text: '搭建哪吒 Telegram 机器人', link: '/case/case1' },
+ { text: '使用Siri语音运行快捷指令查询服务器状态', link: '/case/case2' }
+ ]
+ }
+ ]
+}
+
function getDeveloperSidebarZhCN() {
return [
{
@@ -160,6 +179,18 @@ function getGuideSidebarEnUS() {
]
}
+function getCaseSidebarEnUS() {
+ return [
+ {
+ text: 'Community Projects',
+ children: [
+ { text: 'Build your own Telegram bot to query server information', link: '/en_US/case/case1' },
+ { text: 'Use Siri to run shortcut to check server status', link: '/en_US/case/case2' }
+ ]
+ }
+ ]
+}
+
function getDeveloperSidebarEnUS() {
return [
{
diff --git a/docs/case/case1.md b/docs/case/case1.md
new file mode 100644
index 00000000..441bc4ef
--- /dev/null
+++ b/docs/case/case1.md
@@ -0,0 +1,8 @@
+# 自建一个TG机器人来查询服务器信息
+贡献者:
++ [spiritLHLS](https://github.com/spiritLHLS)
++ [Erope](https://github.com/Erope/)
+
+项目地址:[nezha_api_tgbot](https://github.com/spiritLHLS/nezha_api_tgbot)
+机器人可以通过API向面板请求服务器状态信息,得到信息后发送给用户
+你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板
\ No newline at end of file
diff --git a/docs/case/case2.md b/docs/case/case2.md
new file mode 100644
index 00000000..8e405c6b
--- /dev/null
+++ b/docs/case/case2.md
@@ -0,0 +1,21 @@
+# 在iOS/MacOS中使用Siri运行快捷指令查询服务器状态
+当前版本:V1.0
+贡献者:
++ 白歌 [hhhkkk520](https://github.com/hhhkkk520)
+
+## 获取快捷指令
+使用iPhone或iPad扫描以下二维码,获取快捷指令
+
+
+
+MacOS用户请访问[这里](https://www.icloud.com/shortcuts/312005bf5ffd4387ac92a84056db9f09),获取快捷指令
+
+## 使用说明
++ 获取快捷指令后,打开并编辑快捷指令
++ 分别在三个文本框中填入 `面板URL`、`API Token`、`服务器ID`
++ 保存编辑并测试运行,能获取结果则表示设置正确
++ 修改快捷指令的名称,如修改为:“一号服务器状态”,保存后便可使用Siri指令:“嘿Siri,一号服务器状态”来获取服务器状态
+
+::: warning
+每个快捷指令只能监控一台服务器,如需要监控多个服务器,请多次复制此快捷指令并分别配置,然后分别修改快捷指令名称,如;一号服务器状态、二号服务器状态等
+:::
\ No newline at end of file
diff --git a/docs/case/index.md b/docs/case/index.md
new file mode 100644
index 00000000..f1e6c503
--- /dev/null
+++ b/docs/case/index.md
@@ -0,0 +1,14 @@
+---
+home: true
+heroImage: https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg
+heroText: 哪吒监控社区项目
+tagline: 哪吒监控社区贡献的相关项目,为哪吒监控提供了更多扩展
+actionText: 查看项目 →
+actionLink: /case/case1
+features:
+- title: 提交项目
+ details: 我们欢迎您提交自己的项目,请加入TG群联系管理员了解相关事宜
+- title: 注意事项
+ details: 所有项目均由社区成员贡献,请您知悉哪吒监控团队无法为社区项目承担包括且不限于:保修、可用性、安全性等责任
+---
+
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。
diff --git a/docs/en_US/case/case1.md b/docs/en_US/case/case1.md
new file mode 100644
index 00000000..1e9bbf75
--- /dev/null
+++ b/docs/en_US/case/case1.md
@@ -0,0 +1,8 @@
+# Build your own Telegram bot to query server information
+Contributors:
++ [spiritLHLS](https://github.com/spiritLHLS)
++ [Erope](https://github.com/Erope/)
+
+Project: [nezha_api_tgbot](https://github.com/spiritLHLS/nezha_api_tgbot) (Chinese)
+The bot can request server status information from the Dashboard through the API, and then send the information to the user.
+You can build this bot to easily view the current status of a given server without opening the Dashboard.
\ No newline at end of file
diff --git a/docs/en_US/case/case2.md b/docs/en_US/case/case2.md
new file mode 100644
index 00000000..e86087a5
--- /dev/null
+++ b/docs/en_US/case/case2.md
@@ -0,0 +1,21 @@
+# Use Siri to run shortcut to check server status in iOS/MacOS
+Current Version:V1.0 (Chinese)
+Contributor:
++ 白歌 [hhhkkk520](https://github.com/hhhkkk520)
+
+## Get shortcut command
+Scan the following QR code with your iPhone or iPad to get the shortcut
+
+
+
+MacOS users please visit [here](https://www.icloud.com/shortcuts/312005bf5ffd4387ac92a84056db9f09) to get the shortcut
+
+## How to use
++ After getting the shortcut, open and edit the shortcut
++ Fill in `Dashboard URL`, `API Token`, `Server ID` in the three text boxes
++ Save the edit and test run, if you can get the result, the setting is correct.
++ Modify the name of the shortcut, such as: Server Status, then you can use Siri command: "Hey Siri, Server Status" to get the server status.
+
+::: warning
+Each shortcut can only monitor one server, if you need to monitor more than one server, please copy this shortcut several times and configure them separately, then modify the shortcut name separately, such as; Server 1 Status, Server 2 Status, etc.
+:::
\ No newline at end of file
diff --git a/docs/en_US/case/index.md b/docs/en_US/case/index.md
new file mode 100644
index 00000000..05671697
--- /dev/null
+++ b/docs/en_US/case/index.md
@@ -0,0 +1,14 @@
+---
+home: true
+heroImage: https://raw.githubusercontent.com/naiba/nezha/master/resource/static/brand.svg
+heroText: Nezha Monitoring Community Project
+tagline: Related projects contributed by Nezha Monitoring community, provide more extensions for Nezha Monitoring
+actionText: Learn More →
+actionLink: /en_US/case/case1
+features:
+- title: Submit a project
+ details: We welcome you to submit your own projects, please join the Telegram group and contact the administrator for more information
+- title: Important Notes
+ details: All projects are contributed by community members. Please be aware that Nezha monitoring team cannot be held responsible for community projects including and not limited to warranty, availability, security, etc.
+---
+
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
\ No newline at end of file
diff --git a/docs/en_US/guide/api.md b/docs/en_US/guide/api.md
index c3338373..3ca29d5a 100644
--- a/docs/en_US/guide/api.md
+++ b/docs/en_US/guide/api.md
@@ -148,8 +148,3 @@ JSON Return Example:
]
}
```
-
-## Case - Build your own Telegram bot to query server information
-Refer to [Community Project](https://github.com/spiritLHLS/nezha_api_tgbot) (Chinese)
-The bot can request server status information from the Dashboard through the API, and then send the information to the user.
-You can build this bot to easily view the current status of a given server without opening the Dashboard.
\ No newline at end of file
diff --git a/docs/guide/api.md b/docs/guide/api.md
index 72cec612..bf79bfdb 100644
--- a/docs/guide/api.md
+++ b/docs/guide/api.md
@@ -148,8 +148,3 @@ JSON返回示例:
]
}
```
-
-## 使用案例 - 自建一个TG机器人来查询服务器信息
-参考[社区项目](https://github.com/spiritLHLS/nezha_api_tgbot)
-机器人可以通过API向面板请求服务器状态信息,得到信息后发送给用户
-你可以搭建此机器人来方便地查看指定服务器的当前状态且不需要打开面板
\ No newline at end of file
diff --git a/docs/images/case2/qrcode.png b/docs/images/case2/qrcode.png
new file mode 100644
index 00000000..bf852b9c
Binary files /dev/null and b/docs/images/case2/qrcode.png differ
diff --git a/docs/images/line-numbers-desktop.png b/docs/images/line-numbers-desktop.png
deleted file mode 100644
index e16e6707..00000000
Binary files a/docs/images/line-numbers-desktop.png and /dev/null differ
diff --git a/docs/images/line-numbers-mobile.gif b/docs/images/line-numbers-mobile.gif
deleted file mode 100644
index 87af6cf0..00000000
Binary files a/docs/images/line-numbers-mobile.gif and /dev/null differ
diff --git a/docs/images/vercel-configuration.png b/docs/images/vercel-configuration.png
deleted file mode 100644
index 51874e15..00000000
Binary files a/docs/images/vercel-configuration.png and /dev/null differ