fix

dromara · Jul 10, 2023 · 52ffc45 · 52ffc45
1 parent f4106de
commit 52ffc45
Show file tree

Hide file tree

Showing 5 changed files with 104 additions and 95 deletions.
diff --git a/README.md b/README.md
@@ -43,11 +43,14 @@
 
 <img src="https://raw.githubusercontent.com/mouday/domain-admin/master/image/screencapture-mini.png" style="width: 220px;">
 
-- 移动端预览地址：[https://mouday.github.io/domain-admin-mini/](https://mouday.github.io/domain-admin-mini/)
+- 移动端预览地址(请使用移动端窗口体验)：[https://mouday.github.io/domain-admin-mini/](https://mouday.github.io/domain-admin-mini/)
 
 账号密码随意，预览模式仅提供模拟数据，无法操作修改
 
-使用文档：[https://mouday.github.io/domain-admin/](https://mouday.github.io/domain-admin/)
+使用文档：
+
+- github: [https://mouday.github.io/domain-admin/](https://mouday.github.io/domain-admin/)
+- gitee: [https://mouday.gitee.io/domain-admin/](https://mouday.gitee.io/domain-admin/)
 
 ## 安装
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,93 +1,3 @@
-# 接口文档
+# Domain Admin
 
-说明
-
-请求方式统一为`POST json`
-
-```
-POST /api/<url>
-Content-Type: application/json
-X-TOKEN: <token>
-
-{}
-```
-
-注册登录
-
-| 接口 | 说明 | 文档 | 
-| - | - | -|  
-| /api/register | 用户注册 | [register.md](/auth/register.md) |
-| /api/login | 用户登录 | [login.md](/auth/login.md) |
-
-域名管理
-
-| 接口 | 说明 | 文档 | 
-| - | - | -|  
-| /api/addDomain | 添加域名 | [addDomain.md](/domain/addDomain.md) | 
-| /api/getDomainList | 获取域名列表 | [getDomainList.md](/domain/getDomainList.md) | 
-| /api/getDomainById | 获取域名 | [getDomainById.md](/domain/getDomainById.md) | 
-| /api/updateDomainById | 更新数据 | [updateDomainById.md](/domain/updateDomainById.md) | 
-| /api/deleteDomainById | 删除域名 | [deleteDomainById.md](/domain/deleteDomainById.md) |
-| /api/updateDomainCertInfoById | 更新域名证书信息 | [updateDomainCertInfoById.md](/domain/updateDomainCertInfoById.md) |
-| /api/updateAllDomainCertInfo | 更新所有域名证书信息 | [updateAllDomainCertInfo.md](/domain/updateAllDomainCertInfo.md) |
-| /api/updateAllDomainCertInfoOfUser | 更新当前用户的所有域名信息 | [updateAllDomainCertInfoOfUser.md](/domain/updateAllDomainCertInfoOfUser.md) |
-| /api/sendDomainInfoListEmail | 发送域名证书信息到邮箱 | [sendDomainInfoListEmail.md](/domain/sendDomainInfoListEmail.md) |
-| /api/checkDomainCert | 检查域名证书到期信息 | [checkDomainCert.md](/domain/checkDomainCert.md) |
-| /api/importDomainFromFile | 从文件导入域名 | [importDomainFromFile.md](/domain/importDomainFromFile.md) |
-| /api/getAllDomainListOfUser | 获取用户的所有域名数据 | [getAllDomainListOfUser.md](/domain/getAllDomainListOfUser.md) |
-
-分组管理
-
-| 接口 | 说明 | 文档 | 
-| - | - | -| 
-| /api/addGroup | 添加分组 | [addGroup.md](/group/addGroup.md) | 
-| /api/getGroupList | 获取分组列表 | [getGroupList.md](/group/getGroupList.md) | 
-| /api/getGroupById | 获取分组数据 | [getGroupById.md](/group/getGroupById.md) | 
-| /api/updateGroupById | 更新数据 | [updateGroupById.md](/group/updateGroupById.md) | 
-| /api/deleteGroupById | 删除分组 | [deleteGroupById.md](/group/deleteGroupById.md) |
-
-
-用户信息管理
-
-| 接口 | 说明 | 文档 | 
-| - | - | -| 
-| /api/getUserInfo | 获取当前用户信息 | [getUserInfo.md](/user/getUserInfo.md) | 
-| /api/updateUserInfo | 更新当前用户信息 | [updateUserInfo.md](/user/updateUserInfo.md) | 
-| /api/updateUserPassword | 更新用户密码 | [updateUserPassword.md](/user/updateUserPassword.md) | 
-
-调度日志
-
-| 接口 | 说明 | 文档 | 
-| - | - | -|
-| /api/getLogSchedulerList | 获取调度日志列表 | [getLogSchedulerList.md](/log_scheduler/getLogSchedulerList.md) |
-
-系统管理 (管理员权限)
-
-| 接口 | 说明 | 文档 | 
-| - | - | -|
-| /api/getAllSystemConfig | 获取所有配置项 | [getAllSystemConfig.md](/system_config/getAllSystemConfig.md) |
-| /api/updateSystemConfig | 更新单个配置 | [updateSystemConfig.md](/system_config/updateSystemConfig.md) |
-| /api/getSystemVersion | 获取当前应用版本号 | [getSystemVersion.md](/system_config/getSystemVersion.md) |
-
-用户管理 (管理员权限)
-
-| 接口 | 说明 | 文档 | 
-| - | - | -|
-| /api/getUserList | 获取用户列表 | [getUserList.md](/user/getUserList.md) |
-| /api/addUser | 添加用户 | [addUser.md](/user/addUser.md) |
-| /api/updateUserStatus | 更新账号可用状态 | [updateUserStatus.md](/user/updateUserStatus.md) |
-| /api/deleteUser | 删除用户账号 | [deleteUser.md](/user/deleteUser.md) |
-
-域名信息
-
-| 接口 | 说明 | 文档 | 
-| - | - | -| 
-| /api/getCertInformation | 获取域名证书信息 | [getCertInformation.md](/cert/getCertInformation.md) |
-
-通知配置管理 `v0.0.12`
-
-| 接口 | 说明 | 文档 | 
-| - | - | -|
-| /api/getNotifyOfUser | 获取用户通知配置 | [getNotifyOfUser.md](/notify/getNotifyOfUser.md) |
-| /api/updateNotifyOfUser | 更新用户通知配置 | [updateNotifyOfUser.md](/notify/updateNotifyOfUser.md) |
-| /api/testWebhookNotifyOfUser | 测试webhook调用 | [testWebhookNotifyOfUser.md](/notify/testWebhookNotifyOfUser.md) |
+完善中，请参考项目 README
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -0,0 +1,3 @@
+- [使用说明](/)
+- [接口文档](/api.md)
+
diff --git a/docs/api.md b/docs/api.md
@@ -0,0 +1,93 @@
+# 接口文档
+
+说明
+
+请求方式统一为`POST json`
+
+```
+POST /api/<url>
+Content-Type: application/json
+X-TOKEN: <token>
+
+{}
+```
+
+注册登录
+
+| 接口 | 说明 | 文档 | 
+| - | - | -|  
+| /api/register | 用户注册 | [register.md](/auth/register.md) |
+| /api/login | 用户登录 | [login.md](/auth/login.md) |
+
+域名管理
+
+| 接口 | 说明 | 文档 | 
+| - | - | -|  
+| /api/addDomain | 添加域名 | [addDomain.md](/domain/addDomain.md) | 
+| /api/getDomainList | 获取域名列表 | [getDomainList.md](/domain/getDomainList.md) | 
+| /api/getDomainById | 获取域名 | [getDomainById.md](/domain/getDomainById.md) | 
+| /api/updateDomainById | 更新数据 | [updateDomainById.md](/domain/updateDomainById.md) | 
+| /api/deleteDomainById | 删除域名 | [deleteDomainById.md](/domain/deleteDomainById.md) |
+| /api/updateDomainCertInfoById | 更新域名证书信息 | [updateDomainCertInfoById.md](/domain/updateDomainCertInfoById.md) |
+| /api/updateAllDomainCertInfo | 更新所有域名证书信息 | [updateAllDomainCertInfo.md](/domain/updateAllDomainCertInfo.md) |
+| /api/updateAllDomainCertInfoOfUser | 更新当前用户的所有域名信息 | [updateAllDomainCertInfoOfUser.md](/domain/updateAllDomainCertInfoOfUser.md) |
+| /api/sendDomainInfoListEmail | 发送域名证书信息到邮箱 | [sendDomainInfoListEmail.md](/domain/sendDomainInfoListEmail.md) |
+| /api/checkDomainCert | 检查域名证书到期信息 | [checkDomainCert.md](/domain/checkDomainCert.md) |
+| /api/importDomainFromFile | 从文件导入域名 | [importDomainFromFile.md](/domain/importDomainFromFile.md) |
+| /api/getAllDomainListOfUser | 获取用户的所有域名数据 | [getAllDomainListOfUser.md](/domain/getAllDomainListOfUser.md) |
+
+分组管理
+
+| 接口 | 说明 | 文档 | 
+| - | - | -| 
+| /api/addGroup | 添加分组 | [addGroup.md](/group/addGroup.md) | 
+| /api/getGroupList | 获取分组列表 | [getGroupList.md](/group/getGroupList.md) | 
+| /api/getGroupById | 获取分组数据 | [getGroupById.md](/group/getGroupById.md) | 
+| /api/updateGroupById | 更新数据 | [updateGroupById.md](/group/updateGroupById.md) | 
+| /api/deleteGroupById | 删除分组 | [deleteGroupById.md](/group/deleteGroupById.md) |
+
+
+用户信息管理
+
+| 接口 | 说明 | 文档 | 
+| - | - | -| 
+| /api/getUserInfo | 获取当前用户信息 | [getUserInfo.md](/user/getUserInfo.md) | 
+| /api/updateUserInfo | 更新当前用户信息 | [updateUserInfo.md](/user/updateUserInfo.md) | 
+| /api/updateUserPassword | 更新用户密码 | [updateUserPassword.md](/user/updateUserPassword.md) | 
+
+调度日志
+
+| 接口 | 说明 | 文档 | 
+| - | - | -|
+| /api/getLogSchedulerList | 获取调度日志列表 | [getLogSchedulerList.md](/log_scheduler/getLogSchedulerList.md) |
+
+系统管理 (管理员权限)
+
+| 接口 | 说明 | 文档 | 
+| - | - | -|
+| /api/getAllSystemConfig | 获取所有配置项 | [getAllSystemConfig.md](/system_config/getAllSystemConfig.md) |
+| /api/updateSystemConfig | 更新单个配置 | [updateSystemConfig.md](/system_config/updateSystemConfig.md) |
+| /api/getSystemVersion | 获取当前应用版本号 | [getSystemVersion.md](/system_config/getSystemVersion.md) |
+
+用户管理 (管理员权限)
+
+| 接口 | 说明 | 文档 | 
+| - | - | -|
+| /api/getUserList | 获取用户列表 | [getUserList.md](/user/getUserList.md) |
+| /api/addUser | 添加用户 | [addUser.md](/user/addUser.md) |
+| /api/updateUserStatus | 更新账号可用状态 | [updateUserStatus.md](/user/updateUserStatus.md) |
+| /api/deleteUser | 删除用户账号 | [deleteUser.md](/user/deleteUser.md) |
+
+域名信息
+
+| 接口 | 说明 | 文档 | 
+| - | - | -| 
+| /api/getCertInformation | 获取域名证书信息 | [getCertInformation.md](/cert/getCertInformation.md) |
+
+通知配置管理 `v0.0.12`
+
+| 接口 | 说明 | 文档 | 
+| - | - | -|
+| /api/getNotifyOfUser | 获取用户通知配置 | [getNotifyOfUser.md](/notify/getNotifyOfUser.md) |
+| /api/updateNotifyOfUser | 更新用户通知配置 | [updateNotifyOfUser.md](/notify/updateNotifyOfUser.md) |
+| /api/testWebhookNotifyOfUser | 测试webhook调用 | [testWebhookNotifyOfUser.md](/notify/testWebhookNotifyOfUser.md) |
diff --git a/docs/index.html b/docs/index.html
@@ -94,7 +94,7 @@
         loadSidebar: true,
 
         // 导航栏
-        // loadNavbar: true,
+        loadNavbar: true,
 
 
         repo: "mouday/domain-admin",