diff --git a/.claude/settings.local.json b/.claude/settings.local.json new file mode 100644 index 0000000..0a37a01 --- /dev/null +++ b/.claude/settings.local.json @@ -0,0 +1,7 @@ +{ + "permissions": { + "allow": [ + "WebSearch" + ] + } +} diff --git a/custom.css b/custom.css new file mode 100644 index 0000000..2d038b8 --- /dev/null +++ b/custom.css @@ -0,0 +1,13 @@ +/* Scale up logo rendering */ +img[alt*="logo" i], +img[src*="logo"], +img[src*="favicon"] { + max-height: 72px !important; + height: auto !important; + width: auto !important; +} + +/* Page description (frontmatter) - match body text size */ +header .text-lg { + font-size: 1rem; +} diff --git a/docs.json b/docs.json index ab1bd73..9049967 100644 --- a/docs.json +++ b/docs.json @@ -1,76 +1,71 @@ { "$schema": "https://mintlify.com/docs.json", "theme": "mint", - "name": "用户手册", + "name": "AutoLibrary Manuals", "colors": { "primary": "#64ffda", "light": "#64ffda", "dark": "#64ffda" }, "favicon": "/favicon.svg", + "fonts": { + "family": "Inter" + }, "navigation": { - "languages": [ + "tabs": [ { - "language": "zh", - "default": true, - "groups": [ + "tab": "用户手册", + "languages": [ { - "group": "概览", - "icon": "book-open", - "pages": [ - "zh/index" - ] - }, - { - "group": "安装", - "icon": "download", - "pages": [ - "zh/installation/install", - "zh/installation/driver" - ] - }, - { - "group": "配置", - "icon": "sliders", - "pages": [ - "zh/configuration/start", - "zh/configuration/ui", - "zh/configuration/file" - ] - }, - { - "group": "功能", - "icon": "bolt", - "pages": [ - "zh/features/core", - "zh/features/timer" - ] - }, - { - "group": "FAQ", - "icon": "circle-question", - "pages": [ - "zh/faq/troubleshooting", - "zh/faq/faq" + "language": "zh", + "default": true, + "groups": [ + { + "group": "开始", + "icon": "book-open", + "pages": [ + "zh/index" + ] + }, + { + "group": "安装", + "icon": "download", + "pages": [ + "zh/installation/install", + "zh/installation/driver" + ] + }, + { + "group": "配置", + "icon": "sliders", + "pages": [ + "zh/configuration/start", + "zh/configuration/ui", + "zh/configuration/file" + ] + }, + { + "group": "功能", + "icon": "bolt", + "pages": [ + "zh/features/core", + "zh/features/timer" + ] + }, + { + "group": "FAQ", + "icon": "circle-question", + "pages": [ + "zh/faq/troubleshooting", + "zh/faq/faq", + "zh/faq/contact" + ] + } ] } ] } - ], - "global": { - "anchors": [ - { - "anchor": "Support", - "href": "mailto:nanoki_zh@163.com", - "icon": "envelope" - }, - { - "anchor": "Github Issues", - "href": "https://github.com/KenanZhu/AutoLibrary/issues", - "icon": "github" - } - ] - } + ] }, "logo": { "light": "/logo/light.svg", diff --git a/favicon.svg b/favicon.svg index d2bf063..417c038 100644 --- a/favicon.svg +++ b/favicon.svg @@ -1,12 +1,15 @@ - - - - - - - - - - - \ No newline at end of file + + + + + + + + + + + + + + diff --git a/logo/dark.svg b/logo/dark.svg index a4a67a9..b1f988b 100644 --- a/logo/dark.svg +++ b/logo/dark.svg @@ -1,13 +1,17 @@ - - - - - - - - - + + + + + + + + + + + + + - AutoLibrary Manuals + AutoLibrary Manuals diff --git a/logo/light.svg b/logo/light.svg index 00ca62d..e6d95dc 100644 --- a/logo/light.svg +++ b/logo/light.svg @@ -1,13 +1,17 @@ - - - - - - - - - + + + + + + + + + + + + + - AutoLibrary Manuals + AutoLibrary Manuals diff --git a/style.css b/style.css index 3e5c62a..2d038b8 100644 --- a/style.css +++ b/style.css @@ -6,3 +6,8 @@ img[src*="favicon"] { height: auto !important; width: auto !important; } + +/* Page description (frontmatter) - match body text size */ +header .text-lg { + font-size: 1rem; +} diff --git a/zh/faq/contact.mdx b/zh/faq/contact.mdx new file mode 100644 index 0000000..a660718 --- /dev/null +++ b/zh/faq/contact.mdx @@ -0,0 +1,91 @@ +--- +title: "联系我们" +description: "AutoLibrary 的相关链接,以及快速获取联系我们的方式" +--- + +## 相关链接 + +下列是快速获取与 AutoLibrary 相关的最新信息的方式,你可以跟踪最新的开发进展 +以及未来的开发规划 + + + + 项目的官方源码托管仓库、版本发布与 Issue 跟踪。 + + + 获取 AutoLibrary 最新版本安装包。 + + + 查看各版本更新内容与修复记录。 + + + 国内自托管镜像仓库,提供更快的访问与其它个性化内容。 + + + + + Gitea 镜像仓库与 Github 主仓库的同步间隔为 8 小时,因此提交的不一致问题是正常的,请等待 + Gitea 镜像仓库同步后再次检查。 + + +## 问题反馈 + +如果在使用 AutoLibrary 过程中遇到了一些问题,并且无法在本文档站点中寻找到任何解决方法; +亦或者是对 AutoLibrary 有一些自己的意见和建议,欢迎通过下面的各种渠道与我们取得联系 + +### GitHub Issues + +使用过程中遇到问题或需要功能改进,请通过 GitHub Issues 提交反馈: + + + 提交 Bug 报告或功能请求前,请先搜索是否已有相关问题,避免重复提交。 + + +### 邮件联系 + + + 如需直接沟通或商业合作,可通过邮件联系开发者。 + + +## 参与贡献 + +欢迎通过以下方式参与 AutoLibrary 项目,AutoLibrary 通过 [MIT 协议](https://github.com/KenanZhu/AutoLibrary/blob/main/license) 进行开源,你可以对 AutoLibrary 自由的修改并再次分发: + + + + 在 [GitHub](https://github.com/KenanZhu/AutoLibrary) 或 [Gitea](https://gitea.kenanzhu.com/KenanZhu/AutoLibrary) 上 Fork 项目仓库至个人账号。 + + + 基于 main 分支创建特性分支。 + + + 编写清晰规范的提交信息,推送到 Fork 仓库。 + + + 向主仓库发起 [Pull Request](https://github.com/KenanZhu/AutoLibrary/pulls),描述修改内容与目的。 + + diff --git a/zh/faq/troubleshooting.mdx b/zh/faq/troubleshooting.mdx index 534071b..cd0298c 100644 --- a/zh/faq/troubleshooting.mdx +++ b/zh/faq/troubleshooting.mdx @@ -56,7 +56,7 @@ description: "AutoLibrary 故障排除与常见问题解决方法" ## 定时任务显示"已就绪"或"执行中"且无法删除 - 此解决方法需要直接操作 AutoLibrary 的核心配置文件,需要操作者对 JSON 文件格式有一定了解。**操作前请务必备份相关文件**,以免误操作导致配置丢失。 + 此解决方法需要直接操作 AutoLibrary 的核心配置文件,需要操作者对 [JSON 格式](https://www.json.org/json-zh.html)有一定了解。**操作前请务必备份相关文件**,以免误操作导致配置丢失。 这一般是因为定时任务已进入预约队列,但软件上次异常关闭未能处理完毕。请按以下步骤手动删除: @@ -69,14 +69,16 @@ description: "AutoLibrary 故障排除与常见问题解决方法" 在 AutoLibrary 配置界面的「其它」选项卡中,找到「当前运行配置文件的路径」显示的文件夹路径,使用文件管理器打开该目录。 - 在该目录中找到名为 `timer_task.json` 的文件,使用文本编辑器打开(推荐 VS Code、Notepad++,也可使用记事本)。 + 在该目录中找到名为 `timer_task.json` 的文件,使用文本编辑器打开(推荐 [VS Code](https://code.visualstudio.com/)、[Notepad++](https://notepad-plus-plus.org/),也可直接使用记事本)。 在 JSON 文件中查找包含以下信息的任务配置块: - `name`(任务名称) - `execute_time`(执行时间) - 如果任务名包含中文,在 JSON 中会以 Unicode 编码显示,如 `"name": "预约任务"`。可使用在线工具搜索「Unicode 转中文」进行转换确认。 + 如果任务名包含中文,在 JSON 中会以 Unicode 编码显示, + 如 `"name": "预约任务"` 在 Unicode 显示下会变为: `"name": "\u9884\u7ea6\u4efb\u52a1"`。 + 可使用在线工具搜索「Unicode 转中文」进行转换确认。 将找到的任务配置块从 JSON 文件中完全删除。 diff --git a/zh/index.mdx b/zh/index.mdx index 2960f30..0c4f158 100644 --- a/zh/index.mdx +++ b/zh/index.mdx @@ -1,14 +1,12 @@ --- -title: "AutoLibrary" +title: "概述" description: "北京建筑大学图书馆座位自动化工具 - 简化预约、签到、续约流程" icon: "" --- -## 简介 - AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具,旨在简化图书馆座位操作流程。 -## 快速导航 +## 快速开始 - 下载安装工具,配置浏览器驱动 —— 支持一键自动下载。 + 快速开始,安装 AutoLibrary 与其它必要的准备。