Skip to content

Commit

Permalink
fix: broken links (#266)
Browse files Browse the repository at this point in the history
修复所有文档的错误链接。

/kind documentation

```release-note
None
```
  • Loading branch information
ruibaby authored Oct 23, 2023
1 parent 871c231 commit 6446098
Show file tree
Hide file tree
Showing 52 changed files with 76 additions and 78 deletions.
2 changes: 1 addition & 1 deletion docs/developer-guide/core/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ docker build -t halo-dev/halo:2.10.0 .
docker images | grep halo
```

最终部署文档可参考:[使用 Docker Compose 部署](./docker-compose)
最终部署文档可参考:[使用 Docker Compose 部署](../../getting-started/install/docker-compose.md)
4 changes: 2 additions & 2 deletions docs/developer-guide/plugin/examples/todolist.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ description: 这个例子展示了如何开发 Todo List 插件
参考链接:
- [SemVer expression](https://github.com/zafarkhaja/jsemver#semver-expressions-api-ranges)
- [表单定义](../form-schema.md)
- [表单定义](../../form-schema.md)
此时我们已经准备好了可以开发一个 TodoList 插件的一切,下面让我们正式进入 TodoList 插件开发教程。
Expand Down Expand Up @@ -86,7 +86,7 @@ public class TodoListPlugin extends BasePlugin {
./gradlew build
```

使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:
使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:

```yaml
halo:
Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/backup-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 关于备份和迁移的最佳实践
---

:::info
在开始之前,我们推荐你先阅读 [《写在前面》](/getting-started/prepare) 的名词解释部分。
在开始之前,我们推荐你先阅读 [《写在前面》](../getting-started/prepare.md) 的名词解释部分。
:::

## 备份
Expand All @@ -19,7 +19,7 @@ description: 关于备份和迁移的最佳实践

### 整站备份

通过 [《写在前面》](/getting-started/prepare) 的名词解释部分我们可以知道,Halo 的所有数据都是存放在当前用户目录的工作目录(.halo)下的(使用 MySQL 数据库除外,你还需要导出 MySQL 数据)。**所以我们备份整站的数据仅需备份这个目录即可**,不管你使用何种方式。不过,为了操作方便,我们也在后台的小工具中提供了备份整站数据的功能,和上面所说的数据备份一致,点击备份按钮即可打包工作目录文件夹。如下图:
通过 [《写在前面》](../getting-started/prepare.md) 的名词解释部分我们可以知道,Halo 的所有数据都是存放在当前用户目录的工作目录(.halo)下的(使用 MySQL 数据库除外,你还需要导出 MySQL 数据)。**所以我们备份整站的数据仅需备份这个目录即可**,不管你使用何种方式。不过,为了操作方便,我们也在后台的小工具中提供了备份整站数据的功能,和上面所说的数据备份一致,点击备份按钮即可打包工作目录文件夹。如下图:

![halo-workspace-export.png](/img/halo-workspace-export.png)

Expand All @@ -35,4 +35,4 @@ description: 关于备份和迁移的最佳实践

### 整站迁移

此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](/getting-started/install/linux) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](../getting-started/install/docker-compose.md) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
2 changes: 1 addition & 1 deletion docs/user-guide/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,4 +451,4 @@ sequenceDiagram

## 短连接

参考 [1.4.17/Markdown 语法](../../versioned_docs/version-1.4/user-guide/markdown.md#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
参考 [1.4.17/Markdown 语法](https://docs.halo.run/1.4/user-guide/markdown#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
2 changes: 0 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ const config = {
tagline: "Halo 的文档站点",
url: "https://docs.halo.run",
baseUrl: "/",
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon-96x96.png",
i18n: {
defaultLocale: "zh-Hans",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: 与宝塔面板配合使用的指南

## Halo 部署

参见 [在 Linux 环境部署](/getting-started/install/linux)
参见 [在 Linux 环境部署](../linux.md)

:::info
`「作为服务运行」` 部分可以不进行操作,只需测试启动无误即可,后面将使用宝塔面板软件包中的 `Supervisor` 托管 Halo 进程。
Expand All @@ -32,7 +32,7 @@ description: 与宝塔面板配合使用的指南
需要填写的表单信息如下:

- **名称**:随意
- **启动用户**:如果您按照 [在 Linux 环境部署](/getting-started/install/linux) 创建了用于运行 Halo 的用户,则选择您创建的用户即可。否则选择默认的 root。
- **启动用户**:如果您按照 [在 Linux 环境部署](../linux.md) 创建了用于运行 Halo 的用户,则选择您创建的用户即可。否则选择默认的 root。
- **运行目录**:运行包的存放目录,按照实际情况填写,需要保证你所选的目录包含运行包。
- **启动命令**`java -server -Xms256m -Xmx256m -jar halo.jar`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 使用 OneinStack 的 vhost 脚本创建 Halo 站点的 Nginx 配

## Halo 部署

参见 [在 Linux 环境部署](/getting-started/install/linux)
参见 [在 Linux 环境部署](../linux.md)

:::info
`「反向代理」` 部分不进行操作,保证 Halo 服务运行无误即可。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: 与宝塔面板配合使用的指南

## Halo 部署

参见 [在 Linux 环境部署](/getting-started/install/linux)
参见 [在 Linux 环境部署](../linux.md)

:::info
`「作为服务运行」` 部分可以不进行操作,只需测试启动无误即可,后面将使用宝塔面板软件包中的 `Supervisor` 托管 Halo 进程。
Expand All @@ -32,7 +32,7 @@ description: 与宝塔面板配合使用的指南
需要填写的表单信息如下:

- **名称**:随意
- **启动用户**:如果您按照 [在 Linux 环境部署](/getting-started/install/linux) 创建了用于运行 Halo 的用户,则选择您创建的用户即可。否则选择默认的 root。
- **启动用户**:如果您按照 [在 Linux 环境部署](../linux.md) 创建了用于运行 Halo 的用户,则选择您创建的用户即可。否则选择默认的 root。
- **运行目录**:运行包的存放目录,按照实际情况填写,需要保证你所选的目录包含运行包。
- **启动命令**`java -server -Xms256m -Xmx256m -jar halo.jar`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 使用 OneinStack 的 vhost 脚本创建 Halo 站点的 Nginx 配

## Halo 部署

参见 [在 Linux 环境部署](/getting-started/install/linux)
参见 [在 Linux 环境部署](../linux.md)

:::info
`「反向代理」` 部分不进行操作,保证 Halo 服务运行无误即可。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: 与宝塔面板配合使用的指南

## Halo 部署

参见 [在 Linux 环境部署](/getting-started/install/linux)
参见 [在 Linux 环境部署](../linux.md)

:::info
`「作为服务运行」` 部分可以不进行操作,只需测试启动无误即可,后面将使用宝塔面板软件包中的 `Supervisor` 托管 Halo 进程。
Expand All @@ -32,7 +32,7 @@ description: 与宝塔面板配合使用的指南
需要填写的表单信息如下:

- **名称**:随意
- **启动用户**:如果您按照 [在 Linux 环境部署](/getting-started/install/linux) 创建了用于运行 Halo 的用户,则选择您创建的用户即可。否则选择默认的 root。
- **启动用户**:如果您按照 [在 Linux 环境部署](../linux.md) 创建了用于运行 Halo 的用户,则选择您创建的用户即可。否则选择默认的 root。
- **运行目录**:运行包的存放目录,按照实际情况填写,需要保证你所选的目录包含运行包。
- **启动命令**`java -server -Xms256m -Xmx256m -jar halo.jar`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: 使用 OneinStack 的 vhost 脚本创建 Halo 站点的 Nginx 配

## Halo 部署

参见 [在 Linux 环境部署](/getting-started/install/linux)
参见 [在 Linux 环境部署](../linux.md)

:::info
`「反向代理」` 部分不进行操作,保证 Halo 服务运行无误即可。
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.0/developer-guide/core/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ docker build -t halo-dev/halo:2.0.0 .
docker images | grep halo
```

最终部署文档可参考:[使用 Docker Compose 部署](./docker-compose)
最终部署文档可参考:[使用 Docker Compose 部署](../../getting-started/install/docker-compose.md)
4 changes: 2 additions & 2 deletions versioned_docs/version-2.0/user-guide/backup-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 关于备份和迁移的最佳实践
---

:::info
在开始之前,我们推荐你先阅读 [《写在前面》](/getting-started/prepare) 的名词解释部分。
在开始之前,我们推荐你先阅读 [《写在前面》](../getting-started/prepare.md) 的名词解释部分。
:::

## 备份
Expand Down Expand Up @@ -35,4 +35,4 @@ description: 关于备份和迁移的最佳实践

### 整站迁移

此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](/getting-started/install/linux) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](../getting-started/install/docker-compose.md) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
2 changes: 1 addition & 1 deletion versioned_docs/version-2.1/developer-guide/core/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ docker build -t halo-dev/halo:2.0.0 .
docker images | grep halo
```

最终部署文档可参考:[使用 Docker Compose 部署](./docker-compose)
最终部署文档可参考:[使用 Docker Compose 部署](../../getting-started/install/docker-compose.md)
2 changes: 1 addition & 1 deletion versioned_docs/version-2.1/user-guide/backup-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ description: 关于备份和迁移的最佳实践

### 整站迁移

此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](/getting-started/install/linux) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](../getting-started/install/docker-compose.md) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
2 changes: 1 addition & 1 deletion versioned_docs/version-2.1/user-guide/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,4 +451,4 @@ sequenceDiagram

## 短连接

参考 [1.4.17/Markdown 语法](../../versioned_docs/version-1.4/user-guide/markdown.md#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
参考 [1.4.17/Markdown 语法](https://docs.halo.run/1.4/user-guide/markdown#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
2 changes: 1 addition & 1 deletion versioned_docs/version-2.10/developer-guide/core/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ docker build -t halo-dev/halo:2.10.0 .
docker images | grep halo
```

最终部署文档可参考:[使用 Docker Compose 部署](./docker-compose)
最终部署文档可参考:[使用 Docker Compose 部署](../../getting-started/install/docker-compose.md)
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ description: 这个例子展示了如何开发 Todo List 插件
参考链接:
- [SemVer expression](https://github.com/zafarkhaja/jsemver#semver-expressions-api-ranges)
- [表单定义](../form-schema.md)
- [表单定义](../../form-schema.md)
此时我们已经准备好了可以开发一个 TodoList 插件的一切,下面让我们正式进入 TodoList 插件开发教程。
Expand Down Expand Up @@ -86,7 +86,7 @@ public class TodoListPlugin extends BasePlugin {
./gradlew build
```

使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:
使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:

```yaml
halo:
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.10/user-guide/backup-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ description: 关于备份和迁移的最佳实践

### 整站迁移

此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](/getting-started/install/linux) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](../getting-started/install/docker-compose.md) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
2 changes: 1 addition & 1 deletion versioned_docs/version-2.10/user-guide/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,4 +451,4 @@ sequenceDiagram

## 短连接

参考 [1.4.17/Markdown 语法](../../versioned_docs/version-1.4/user-guide/markdown.md#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
参考 [1.4.17/Markdown 语法](https://docs.halo.run/1.4/user-guide/markdown#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
2 changes: 1 addition & 1 deletion versioned_docs/version-2.2/developer-guide/core/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ docker build -t halo-dev/halo:2.0.0 .
docker images | grep halo
```

最终部署文档可参考:[使用 Docker Compose 部署](./docker-compose)
最终部署文档可参考:[使用 Docker Compose 部署](../../getting-started/install/docker-compose.md)
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ description: 这个例子展示了如何开发 Todo List 插件
参考链接:
- [SemVer expression](https://github.com/zafarkhaja/jsemver#semver-expressions-api-ranges)
- [表单定义](../form-schema.md)
- [表单定义](../../form-schema.md)
此时我们已经准备好了可以开发一个 TodoList 插件的一切,下面让我们正式进入 TodoList 插件开发教程。
Expand Down Expand Up @@ -86,7 +86,7 @@ public class TodoListPlugin extends BasePlugin {
./gradlew build
```

使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:
使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:

```yaml
halo:
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.2/user-guide/backup-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ description: 关于备份和迁移的最佳实践

### 整站迁移

此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](/getting-started/install/linux) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
此操作通常用于迁移服务器,基于上面 **整站备份** 所说,Halo 的所有数据都是存放于当前用户目录的工作目录(.halo)下的。当然,这仅限于使用 **H2 Database** 的情况下,如果你使用的 MySQL,那么还需要手动导出 MySQL 数据。所以,我们迁移服务器仅仅需要将工作目录的备份文件上传到新服务器的用户目录下解压,然后按照 [《安装指南》](../getting-started/install/docker-compose.md) 重新安装即可。MySQL 用户还需要做的就是手动导出 MySQL 数据,并在新服务器上导入。
2 changes: 1 addition & 1 deletion versioned_docs/version-2.2/user-guide/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,4 +451,4 @@ sequenceDiagram

## 短连接

参考 [1.4.17/Markdown 语法](../../versioned_docs/version-1.4/user-guide/markdown.md#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
参考 [1.4.17/Markdown 语法](https://docs.halo.run/1.4/user-guide/markdown#短连接)。目前已经在 1.5.x 移除,建议直接使用官方提供的嵌入代码。
4 changes: 2 additions & 2 deletions versioned_docs/version-2.3/developer-guide/core/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 构建为可执行 JAR 和 Docker 镜像的文档
---

:::info
在此之前,我们推荐你先阅读[《准备工作》](./prepare),检查本地环境是否满足要求。
在此之前,我们推荐你先阅读[《准备工作》](./prepare.md),检查本地环境是否满足要求。
:::

一般情况下,为了保证版本一致性和可维护性,我们并不推荐自行构建和二次开发。但考虑到我们目前仅提供 Docker 镜像的发行版本,不再提供可执行 JAR 的发行版本,因此我们提供了构建的文档,以供用户自行构建。
Expand Down Expand Up @@ -100,4 +100,4 @@ docker build -t halo-dev/halo:2.0.0 .
docker images | grep halo
```

最终部署文档可参考:[使用 Docker Compose 部署](./docker-compose)
最终部署文档可参考:[使用 Docker Compose 部署](../../getting-started/install/docker-compose.md)
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ description: 这个例子展示了如何开发 Todo List 插件
参考链接:
- [SemVer expression](https://github.com/zafarkhaja/jsemver#semver-expressions-api-ranges)
- [表单定义](../form-schema.md)
- [表单定义](../../form-schema.md)
此时我们已经准备好了可以开发一个 TodoList 插件的一切,下面让我们正式进入 TodoList 插件开发教程。
Expand Down Expand Up @@ -86,7 +86,7 @@ public class TodoListPlugin extends BasePlugin {
./gradlew build
```

使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:
使用 `IntelliJ IDEA` 打开 Halo,参考 [Halo 开发环境运行](../../core/run.md) 及 [插件入门](../hello-world.md) 配置插件的运行模式和路径:

```yaml
halo:
Expand Down
Loading

1 comment on commit 6446098

@vercel
Copy link

@vercel vercel bot commented on 6446098 Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

halo-docs – ./

halo-docs-git-main-halo-dev.vercel.app
docs.halo.run
halo-docs.vercel.app
halo-docs-halo-dev.vercel.app

Please sign in to comment.