mirror of
https://gitlab.com/KenanZhu/AutoLibraryManuals.git
synced 2026-11-05 13:45:51 +08:00
docs: update repository links for Gitea and GitLab
This commit is contained in:
1 parent
3a3aa57ad6
commit
b3ce024a91
7 files changed
+77
-100
No files matched your search
+12
-13
@@ -6,23 +6,22 @@ Thank you for your interest in contributing to our documentation! This guide wil
|
|||||||
|
|
||||||
## How to contribute
|
## How to contribute
|
||||||
|
|
||||||
### Option 1: Edit directly on GitHub
|
### Edit directly on GitLab
|
||||||
|
|
||||||
1. Navigate to the page you want to edit
|
1. Open the file you want to edit in the [AutoLibrary Manuals repository](https://gitlab.com/KenanZhu/AutoLibraryManuals). If you don't have write access, fork the repository and open the file in your fork.
|
||||||
2. Click the "Edit this file" button (the pencil icon)
|
2. Select **Edit** > **Edit single file** and make your changes.
|
||||||
3. Make your changes and submit a pull request
|
3. Commit your changes to a new branch and open a merge request targeting the manuals repository.
|
||||||
|
|
||||||
### Option 2: Local development
|
### Develop locally
|
||||||
|
|
||||||
1. Fork and clone this repository
|
1. Fork and clone the [AutoLibrary Manuals repository](https://gitlab.com/KenanZhu/AutoLibraryManuals).
|
||||||
2. Install the Mintlify CLI: `npm i -g mint`
|
2. Run `npm i -g mint` to install the Mintlify CLI.
|
||||||
3. Create a branch for your changes
|
3. Create a branch and edit the documentation.
|
||||||
4. Make changes
|
4. Run `mint dev` from the directory containing `docs.json`.
|
||||||
5. Navigate to the docs directory and run `mint dev`
|
5. Preview your changes at `http://localhost:3000`.
|
||||||
6. Preview your changes at `http://localhost:3000`
|
6. Commit and push your branch, then open a merge request targeting the manuals repository.
|
||||||
7. Commit your changes and submit a pull request
|
|
||||||
|
|
||||||
For more details on local development, see our [development guide](development.mdx).
|
For more details, see the [local development instructions](README.md#开发).
|
||||||
|
|
||||||
## Writing guidelines
|
## Writing guidelines
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,10 @@
|
|||||||
|
|
||||||
AutoLibrary 北京建筑大学图书馆自动化工具的 Mintlify 文档站点。
|
AutoLibrary 北京建筑大学图书馆自动化工具的 Mintlify 文档站点。
|
||||||
|
|
||||||
|
- [AutoLibrary 主项目(Gitea)](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary)
|
||||||
|
- [用户手册仓库(GitLab)](https://gitlab.com/KenanZhu/AutoLibraryManuals)
|
||||||
|
- [文档贡献指南](CONTRIBUTING.md)
|
||||||
|
|
||||||
## 图片资源清单
|
## 图片资源清单
|
||||||
|
|
||||||
### v1.3.0
|
### v1.3.0
|
||||||
@@ -60,4 +64,4 @@ mint dev
|
|||||||
|
|
||||||
## 发布
|
## 发布
|
||||||
|
|
||||||
更改推送到默认分支后将自动部署到生产环境。
|
更改推送到 GitLab 仓库的默认分支后将自动部署到生产环境。
|
||||||
@@ -169,9 +169,9 @@
|
|||||||
},
|
},
|
||||||
"links": [
|
"links": [
|
||||||
{
|
{
|
||||||
"label": "GitHub",
|
"label": "项目源码",
|
||||||
"href": "https://github.com/KenanZhu/AutoLibrary",
|
"href": "https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary",
|
||||||
"icon": "github"
|
"icon": "code"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@@ -184,8 +184,20 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"footer": {
|
"footer": {
|
||||||
"socials": {
|
"links": [
|
||||||
"github": "https://github.com/KenanZhu/AutoLibrary"
|
{
|
||||||
}
|
"header": "代码仓库",
|
||||||
|
"items": [
|
||||||
|
{
|
||||||
|
"label": "AutoLibrary(Gitea)",
|
||||||
|
"href": "https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "用户手册(GitLab)",
|
||||||
|
"href": "https://gitlab.com/KenanZhu/AutoLibraryManuals"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -5,23 +5,22 @@ description: "AutoLibrary 的相关链接,以及快速获取联系我们的方
|
|||||||
|
|
||||||
## 相关链接
|
## 相关链接
|
||||||
|
|
||||||
下列是快速获取与 AutoLibrary 相关的最新信息的方式,你可以跟踪最新的开发进展
|
你可以在这里查看 AutoLibrary 源码、下载软件和参与手册维护。
|
||||||
以及未来的开发规划
|
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card
|
<Card
|
||||||
title="GitHub"
|
title="AutoLibrary 主项目(Gitea)"
|
||||||
icon="github"
|
icon="code"
|
||||||
href="https://github.com/KenanZhu/AutoLibrary"
|
href="https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary"
|
||||||
>
|
>
|
||||||
项目的官方源码托管仓库、版本发布与 Issue 跟踪。
|
查看 AutoLibrary 源码和开发进展。
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
title="下载"
|
title="下载"
|
||||||
icon="download"
|
icon="download"
|
||||||
href="https://autolibrary.kenanzhu.com/downloads"
|
href="https://autolibrary.kenanzhu.com/downloads"
|
||||||
>
|
>
|
||||||
获取 AutoLibrary 最新版本安装包。
|
查看可用的 AutoLibrary 安装包。
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
title="更新日志"
|
title="更新日志"
|
||||||
@@ -31,32 +30,27 @@ description: "AutoLibrary 的相关链接,以及快速获取联系我们的方
|
|||||||
查看各版本更新内容与修复记录。
|
查看各版本更新内容与修复记录。
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
title="Gitea 镜像"
|
title="用户手册(GitLab)"
|
||||||
icon="https://gitea.kenanzhu.com/assets/img/favicon.png"
|
icon="book-open"
|
||||||
href="https://gitea.kenanzhu.com/KenanZhu/AutoLibrary"
|
href="https://gitlab.com/KenanZhu/AutoLibraryManuals"
|
||||||
>
|
>
|
||||||
国内自托管镜像仓库,提供更快的访问与其它个性化内容。
|
查看手册源码或提交文档修改。
|
||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
<Info>
|
|
||||||
Gitea 镜像仓库与 GitHub 主仓库的同步间隔为 8 小时,因此提交的不一致问题是正常的,请等待
|
|
||||||
Gitea 镜像仓库同步后再次检查。
|
|
||||||
</Info>
|
|
||||||
|
|
||||||
## 问题反馈
|
## 问题反馈
|
||||||
|
|
||||||
如果在使用 AutoLibrary 过程中遇到了一些问题,并且无法在本文档站点中寻找到任何解决方法;
|
如果在使用 AutoLibrary 过程中遇到了一些问题,并且无法在本文档站点中寻找到任何解决方法;
|
||||||
亦或者是对 AutoLibrary 有一些自己的意见和建议,欢迎通过下面的各种渠道与我们取得联系
|
亦或者是对 AutoLibrary 有一些自己的意见和建议,欢迎通过下面的各种渠道与我们取得联系
|
||||||
|
|
||||||
### GitHub Issues
|
### Gitea Issues
|
||||||
|
|
||||||
使用过程中遇到问题或需要功能改进,请通过 GitHub Issues 提交反馈:
|
使用过程中遇到问题或需要功能改进,请通过 Gitea Issues 提交反馈。
|
||||||
|
|
||||||
<Card
|
<Card
|
||||||
title="提交 Issue"
|
title="提交 Issue"
|
||||||
icon="circle-dot"
|
icon="circle-dot"
|
||||||
href="https://github.com/KenanZhu/AutoLibrary/issues"
|
href="https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/issues"
|
||||||
>
|
>
|
||||||
提交 Bug 报告或功能请求前,请先搜索是否已有相关问题,避免重复提交。
|
提交 Bug 报告或功能请求前,请先搜索是否已有相关问题,避免重复提交。
|
||||||
</Card>
|
</Card>
|
||||||
@@ -73,19 +67,10 @@ description: "AutoLibrary 的相关链接,以及快速获取联系我们的方
|
|||||||
|
|
||||||
## 参与贡献
|
## 参与贡献
|
||||||
|
|
||||||
欢迎通过以下方式参与 AutoLibrary 项目,AutoLibrary 通过 [MIT 协议](https://github.com/KenanZhu/AutoLibrary/blob/main/license) 进行开源,你可以对 AutoLibrary 自由的修改并再次分发:
|
### 参与主项目
|
||||||
|
|
||||||
<Steps>
|
AutoLibrary 采用 [MIT 许可证](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/src/branch/main/LICENSE)。如果你想贡献代码,请先在 [Gitea Issues](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/issues) 说明你想解决的问题和拟议改动,与维护者讨论提交方式。
|
||||||
<Step title="Fork 仓库">
|
|
||||||
在 [GitHub](https://github.com/KenanZhu/AutoLibrary) 或 [Gitea](https://gitea.kenanzhu.com/KenanZhu/AutoLibrary) 上 Fork 项目仓库至个人账号。
|
### 改进用户手册
|
||||||
</Step>
|
|
||||||
<Step title="创建分支">
|
如果你想修正或补充手册内容,请在 [GitLab 手册仓库](https://gitlab.com/KenanZhu/AutoLibraryManuals) 修改对应的 `.mdx` 文件,然后提交 [Merge Request](https://gitlab.com/KenanZhu/AutoLibraryManuals/-/merge_requests)。
|
||||||
基于 <code>main</code> 分支创建特性分支。
|
|
||||||
</Step>
|
|
||||||
<Step title="提交更改">
|
|
||||||
编写清晰规范的提交信息,推送到 Fork 仓库。
|
|
||||||
</Step>
|
|
||||||
<Step title="发起 Pull Request">
|
|
||||||
向主仓库发起 [Pull Request](https://github.com/KenanZhu/AutoLibrary/pulls),描述修改内容与目的。
|
|
||||||
</Step>
|
|
||||||
</Steps>
|
|
||||||
@@ -11,12 +11,10 @@ AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具
|
|||||||
|
|
||||||
## 下载软件
|
## 下载软件
|
||||||
|
|
||||||
请从 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads)获取最新版本。
|
请在 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads) 查看可用的安装包。
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
[**GitHub Releases**](https://github.com/KenanZhu/AutoLibrary/releases):更新较为及时,但网络连接不稳定,速度较慢。
|
你也可以在 [Gitea 发布页](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/releases) 查看主仓库的发布记录。
|
||||||
|
|
||||||
**云盘链接**:版本更新略有延迟,但下载速度更快。
|
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
## 安装类型
|
## 安装类型
|
||||||
|
|||||||
@@ -5,30 +5,29 @@ description: "AutoLibrary 的相关链接,以及快速获取联系我们的方
|
|||||||
|
|
||||||
## 相关链接
|
## 相关链接
|
||||||
|
|
||||||
下列是快速获取与 AutoLibrary 相关的最新信息的方式,你可以跟踪最新的开发进展
|
你可以在这里查看 AutoLibrary 源码、下载软件和参与手册维护。
|
||||||
以及未来的开发规划
|
|
||||||
|
|
||||||
<CardGroup cols={2}>
|
<CardGroup cols={2}>
|
||||||
<Card
|
<Card
|
||||||
title="GitHub"
|
title="AutoLibrary 主项目(Gitea)"
|
||||||
icon="github"
|
icon="code"
|
||||||
href="https://github.com/KenanZhu/AutoLibrary"
|
href="https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary"
|
||||||
>
|
>
|
||||||
项目的官方源码托管仓库、版本发布与 Issue 跟踪。
|
查看 AutoLibrary 源码和开发进展。
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
title="Gitea 镜像"
|
title="用户手册(GitLab)"
|
||||||
icon="https://gitea.kenanzhu.com/assets/img/favicon.png"
|
icon="book-open"
|
||||||
href="https://gitea.kenanzhu.com/KenanZhu/AutoLibrary"
|
href="https://gitlab.com/KenanZhu/AutoLibraryManuals"
|
||||||
>
|
>
|
||||||
自托管镜像仓库,提供更快的访问与其它个性化内容。
|
查看手册源码或提交文档修改。
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
title="下载"
|
title="下载"
|
||||||
icon="download"
|
icon="download"
|
||||||
href="https://autolibrary.kenanzhu.com/downloads"
|
href="https://autolibrary.kenanzhu.com/downloads"
|
||||||
>
|
>
|
||||||
获取 AutoLibrary 最新版本安装包。
|
查看可用的 AutoLibrary 安装包。
|
||||||
</Card>
|
</Card>
|
||||||
<Card
|
<Card
|
||||||
title="主题市场"
|
title="主题市场"
|
||||||
@@ -39,24 +38,19 @@ description: "AutoLibrary 的相关链接,以及快速获取联系我们的方
|
|||||||
</Card>
|
</Card>
|
||||||
</CardGroup>
|
</CardGroup>
|
||||||
|
|
||||||
<Info>
|
|
||||||
Gitea 镜像仓库与 GitHub 主仓库的同步间隔为 8 小时,因此出现提交不一致的问题是正常的,
|
|
||||||
请等待 Gitea 镜像仓库同步后再次检查。
|
|
||||||
</Info>
|
|
||||||
|
|
||||||
## 问题反馈
|
## 问题反馈
|
||||||
|
|
||||||
如果在使用 AutoLibrary 过程中遇到了一些问题,并且无法在本文档站点中寻找到任何解决方法;
|
如果在使用 AutoLibrary 过程中遇到了一些问题,并且无法在本文档站点中寻找到任何解决方法;
|
||||||
亦或者是对 AutoLibrary 有一些自己的意见和建议,欢迎通过下面的各种渠道与我们取得联系
|
亦或者是对 AutoLibrary 有一些自己的意见和建议,欢迎通过下面的各种渠道与我们取得联系
|
||||||
|
|
||||||
### GitHub Issues
|
### Gitea Issues
|
||||||
|
|
||||||
使用过程中遇到问题或需要功能改进,请通过 GitHub Issues 提交反馈:
|
使用过程中遇到问题或需要功能改进,请通过 Gitea Issues 提交反馈。
|
||||||
|
|
||||||
<Card
|
<Card
|
||||||
title="提交 Issue"
|
title="提交 Issue"
|
||||||
icon="circle-dot"
|
icon="circle-dot"
|
||||||
href="https://github.com/KenanZhu/AutoLibrary/issues"
|
href="https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/issues"
|
||||||
>
|
>
|
||||||
提交 Bug 报告或功能请求前,请先搜索是否已有相关问题,避免重复提交。
|
提交 Bug 报告或功能请求前,请先搜索是否已有相关问题,避免重复提交。
|
||||||
</Card>
|
</Card>
|
||||||
@@ -73,23 +67,10 @@ description: "AutoLibrary 的相关链接,以及快速获取联系我们的方
|
|||||||
|
|
||||||
## 参与贡献
|
## 参与贡献
|
||||||
|
|
||||||
欢迎通过以下方式参与 AutoLibrary 项目,AutoLibrary 通过 [MIT 协议](https://github.com/KenanZhu/AutoLibrary/blob/main/license) 进行开源,你可以对 AutoLibrary 自由的修改并再次分发:
|
### 参与主项目
|
||||||
|
|
||||||
<Warning>
|
AutoLibrary 采用 [MIT 许可证](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/src/branch/main/LICENSE)。如果你想贡献代码,请先在 [Gitea Issues](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/issues) 说明你想解决的问题和拟议改动,与维护者讨论提交方式。
|
||||||
请通过 GitHub 主仓库提交 PR。Gitea 镜像仅用于数据同步备份,不参与代码贡献流程。
|
|
||||||
</Warning>
|
|
||||||
|
|
||||||
<Steps>
|
### 改进用户手册
|
||||||
<Step title="Fork 仓库">
|
|
||||||
在 [GitHub](https://github.com/KenanZhu/AutoLibrary) 上 Fork 项目仓库至个人账号。
|
如果你想修正或补充手册内容,请在 [GitLab 手册仓库](https://gitlab.com/KenanZhu/AutoLibraryManuals) 修改对应的 `.mdx` 文件,然后提交 [Merge Request](https://gitlab.com/KenanZhu/AutoLibraryManuals/-/merge_requests)。
|
||||||
</Step>
|
|
||||||
<Step title="创建分支">
|
|
||||||
基于 <code>main</code> 分支创建特性分支。
|
|
||||||
</Step>
|
|
||||||
<Step title="提交更改">
|
|
||||||
编写清晰规范的提交信息,推送到 Fork 仓库。
|
|
||||||
</Step>
|
|
||||||
<Step title="发起 Pull Request">
|
|
||||||
向主仓库发起 [Pull Request](https://github.com/KenanZhu/AutoLibrary/pulls),描述修改内容与目的。
|
|
||||||
</Step>
|
|
||||||
</Steps>
|
|
||||||
@@ -7,12 +7,10 @@ AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具
|
|||||||
|
|
||||||
## 下载软件
|
## 下载软件
|
||||||
|
|
||||||
请从 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads) 获取最新版本。
|
请在 [AutoLibrary 下载页面](https://autolibrary.kenanzhu.com/downloads) 查看可用的安装包。
|
||||||
|
|
||||||
<Note>
|
<Note>
|
||||||
[**GitHub Releases**](https://github.com/KenanZhu/AutoLibrary/releases):更新较为及时,但网络连接不稳定,速度较慢。
|
你也可以在 [Gitea 发布页](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/releases) 查看主仓库的发布记录。
|
||||||
|
|
||||||
**云盘链接**:版本更新略有延迟,但下载速度更快。
|
|
||||||
</Note>
|
</Note>
|
||||||
|
|
||||||
## 安装类型
|
## 安装类型
|
||||||
@@ -47,7 +45,7 @@ AutoLibrary 是一款专为北京建筑大学图书馆设计的自动化工具
|
|||||||
从下载页面获取 `AutoLibrary.<版本号>-macos-arm64.dmg` 文件。
|
从下载页面获取 `AutoLibrary.<版本号>-macos-arm64.dmg` 文件。
|
||||||
|
|
||||||
<Info>
|
<Info>
|
||||||
目前仅提供 Apple Silicon (M 系列芯片) 版本。如果你使用 Intel 芯片的 Mac,请从源码自行构建,详见 [GitHub 仓库](https://github.com/KenanZhu/AutoLibrary) README 中的构建说明。
|
目前仅提供 Apple Silicon (M 系列芯片) 版本。如果你使用 Intel 芯片的 Mac,请按 [Gitea 仓库 README](https://gitea.kenanzhu.com/AutoLibrary/AutoLibrary/src/branch/main/README.md) 中的说明从源码构建。
|
||||||
</Info>
|
</Info>
|
||||||
</Step>
|
</Step>
|
||||||
<Step title="安装应用">
|
<Step title="安装应用">
|
||||||
|
|||||||
Reference in new issue
Block a user