refactor: document versioning structure (#99)
重构文档版本结构。 - 移除 1.5/1.4 相关所有 patch 版本的文档,使用 1.5/1.4 版本号代替。 - 创建 1.6 的文档版本。 - 后续针对 1.5 或者 1.6 的更新,可以直接对具体版本进行更改。 本打算使用 [@docusaurus/plugin-client-redirects](https://docusaurus.io/zh-CN/docs/api/plugins/@docusaurus/plugin-client-redirects) 做已删除的 patch 版本的重定向,旦可能不是很好满足匹配重定向的需求。~~所以在此 PR 合并之前我将通过 Nginx 对具体版本进行重定向转发~~。 比如:`/1.4.17/{path}` 重定向到 `/1.4/{path}`,`/1.5.4/{path}` `/1.5.3/{path}` 都从定向到 `/1.5/{path}` /kind documentation /cc @halo-dev/sig-docs > PS: 此 PR 未对新发布的 [1.6.0](https://github.com/halo-dev/halo/releases/tag/v1.6.0) [1.5.5](https://github.com/halo-dev/halo/releases/tag/v1.5.5) [2.0.0-alpha.2](https://github.com/halo-dev/halo/releases/tag/v2.0.0-alpha.2) 做修改,将在后续 PR 更改。 ```release-note None ```JohnNiang-patch-1
parent
99a14110b9
commit
4921736046
@ -1,46 +0,0 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "1.4.17",
|
||||
"description": "The label for version 1.4.17"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.入门": {
|
||||
"message": "入门",
|
||||
"description": "The label for category 入门 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.安装指南": {
|
||||
"message": "安装指南",
|
||||
"description": "The label for category 安装指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.其他指南": {
|
||||
"message": "其他指南",
|
||||
"description": "The label for category 其他指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.用户指南": {
|
||||
"message": "用户指南",
|
||||
"description": "The label for category 用户指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.开发者指南": {
|
||||
"message": "开发者指南",
|
||||
"description": "The label for category 开发者指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.系统开发": {
|
||||
"message": "系统开发",
|
||||
"description": "The label for category 系统开发 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.主题开发": {
|
||||
"message": "主题开发",
|
||||
"description": "The label for category 主题开发 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.参与贡献": {
|
||||
"message": "参与贡献",
|
||||
"description": "The label for category 参与贡献 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.link.腾讯云开发者实验室": {
|
||||
"message": "腾讯云开发者实验室",
|
||||
"description": "The label for link 腾讯云开发者实验室 in sidebar tutorialSidebar, linking to https://cloud.tencent.com/developer/labs/lab/10523"
|
||||
},
|
||||
"sidebar.tutorialSidebar.link.REST API": {
|
||||
"message": "REST API",
|
||||
"description": "The label for link REST API in sidebar tutorialSidebar, linking to https://api.halo.run"
|
||||
}
|
||||
}
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "1.5.0",
|
||||
"description": "The label for version 1.5.0"
|
||||
"message": "1.4",
|
||||
"description": "The label for version 1.4"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.入门": {
|
||||
"message": "入门",
|
@ -1,42 +0,0 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "1.5.1",
|
||||
"description": "The label for version 1.5.1"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.入门": {
|
||||
"message": "入门",
|
||||
"description": "The label for category 入门 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.安装指南": {
|
||||
"message": "安装指南",
|
||||
"description": "The label for category 安装指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.其他指南": {
|
||||
"message": "其他指南",
|
||||
"description": "The label for category 其他指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.用户指南": {
|
||||
"message": "用户指南",
|
||||
"description": "The label for category 用户指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.开发者指南": {
|
||||
"message": "开发者指南",
|
||||
"description": "The label for category 开发者指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.系统开发": {
|
||||
"message": "系统开发",
|
||||
"description": "The label for category 系统开发 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.主题开发": {
|
||||
"message": "主题开发",
|
||||
"description": "The label for category 主题开发 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.参与贡献": {
|
||||
"message": "参与贡献",
|
||||
"description": "The label for category 参与贡献 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.link.REST API": {
|
||||
"message": "REST API",
|
||||
"description": "The label for link REST API in sidebar tutorialSidebar, linking to https://api.halo.run"
|
||||
}
|
||||
}
|
@ -1,42 +0,0 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "1.5.2",
|
||||
"description": "The label for version 1.5.2"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.入门": {
|
||||
"message": "入门",
|
||||
"description": "The label for category 入门 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.安装指南": {
|
||||
"message": "安装指南",
|
||||
"description": "The label for category 安装指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.其他指南": {
|
||||
"message": "其他指南",
|
||||
"description": "The label for category 其他指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.用户指南": {
|
||||
"message": "用户指南",
|
||||
"description": "The label for category 用户指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.开发者指南": {
|
||||
"message": "开发者指南",
|
||||
"description": "The label for category 开发者指南 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.系统开发": {
|
||||
"message": "系统开发",
|
||||
"description": "The label for category 系统开发 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.主题开发": {
|
||||
"message": "主题开发",
|
||||
"description": "The label for category 主题开发 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.参与贡献": {
|
||||
"message": "参与贡献",
|
||||
"description": "The label for category 参与贡献 in sidebar tutorialSidebar"
|
||||
},
|
||||
"sidebar.tutorialSidebar.link.REST API": {
|
||||
"message": "REST API",
|
||||
"description": "The label for link REST API in sidebar tutorialSidebar, linking to https://api.halo.run"
|
||||
}
|
||||
}
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "1.5.3",
|
||||
"description": "The label for version 1.5.3"
|
||||
"message": "1.5",
|
||||
"description": "The label for version 1.5"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.入门": {
|
||||
"message": "入门",
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"version.label": {
|
||||
"message": "1.5.4",
|
||||
"description": "The label for version 1.5.4"
|
||||
"message": "1.6",
|
||||
"description": "The label for version 1.6"
|
||||
},
|
||||
"sidebar.tutorialSidebar.category.入门": {
|
||||
"message": "入门",
|
@ -1,15 +0,0 @@
|
||||
---
|
||||
title: 三方指南
|
||||
---
|
||||
|
||||
:::tip
|
||||
此类指南或教程均来自第三方或者网友提供,我们不能一直保证其具有有效性,请参考的时候仔细甄别。另外,如果您有写类似的教程,也可以[联系我们](mailto:hi@halo.run)放在下方。
|
||||
:::
|
||||
|
||||
- [Halo 博客安装教程,一款优秀的 Java 开源博客系统](https://www.cnblogs.com/bronya0/p/14198512.html)
|
||||
- [如何用服务器优雅地搭建一个博客—Hello,Halo!](https://www.bilibili.com/video/BV1JN411Q7Na/)
|
||||
- [Halo+云服务器+Nginx反向代理实现个人博客搭建](https://yusart.xyz/archives/halo%E4%B8%AA%E4%BA%BA%E5%8D%9A%E5%AE%A2%E6%90%AD%E5%BB%BA)
|
||||
- [如何在 Windows 下搭建 Halo](https://ykanade.cn/2021/08/11/HaloInWindows/)
|
||||
- [Halo 博客建站记录](https://catchersun.cn/archives/halo%E5%8D%9A%E5%AE%A2%E5%BB%BA%E7%AB%99%E8%AE%B0%E5%BD%95)
|
||||
- [Windows下搭建halo并配置nginx与SSL](https://blog.shikangsi.cn/archives/halo-windows)
|
||||
- [Linux环境下如何分布式部署Halo](https://luoxx.top/archives/halo-distributed-deploy)
|
File diff suppressed because it is too large
Load Diff
@ -1,15 +0,0 @@
|
||||
---
|
||||
title: 三方指南
|
||||
---
|
||||
|
||||
:::tip
|
||||
此类指南或教程均来自第三方或者网友提供,我们不能一直保证其具有有效性,请参考的时候仔细甄别。另外,如果您有写类似的教程,也可以[联系我们](mailto:hi@halo.run)放在下方。
|
||||
:::
|
||||
|
||||
- [Halo 博客安装教程,一款优秀的 Java 开源博客系统](https://www.cnblogs.com/bronya0/p/14198512.html)
|
||||
- [如何用服务器优雅地搭建一个博客—Hello,Halo!](https://www.bilibili.com/video/BV1JN411Q7Na/)
|
||||
- [Halo+云服务器+Nginx反向代理实现个人博客搭建](https://yusart.xyz/archives/halo%E4%B8%AA%E4%BA%BA%E5%8D%9A%E5%AE%A2%E6%90%AD%E5%BB%BA)
|
||||
- [如何在 Windows 下搭建 Halo](https://ykanade.cn/2021/08/11/HaloInWindows/)
|
||||
- [Halo 博客建站记录](https://catchersun.cn/archives/halo%E5%8D%9A%E5%AE%A2%E5%BB%BA%E7%AB%99%E8%AE%B0%E5%BD%95)
|
||||
- [Windows下搭建halo并配置nginx与SSL](https://blog.shikangsi.cn/archives/halo-windows)
|
||||
- [Linux环境下如何分布式部署Halo](https://luoxx.top/archives/halo-distributed-deploy)
|
@ -1,16 +0,0 @@
|
||||
---
|
||||
title: 关于文档
|
||||
description: 关于本文档站点的一些说明
|
||||
---
|
||||
|
||||
:::note
|
||||
此文档使用 [Docusaurus](https://docusaurus.io/) 搭建,感谢 [Docusaurus](https://github.com/facebook/docusaurus) 社区所做的贡献。
|
||||
:::
|
||||
|
||||
## 参与贡献
|
||||
|
||||
:::tip
|
||||
如果你发现文档中有不正确或者需要添加的内容,非常欢迎参与到文档编辑当中。
|
||||
:::
|
||||
|
||||
当前文档的仓库地址为 [halo-dev/docs](https://github.com/halo-dev/docs) ,所以你可以 fork 此仓库,修改之后提交 `Pull request` 等待我们合并即可。
|
@ -1,28 +0,0 @@
|
||||
---
|
||||
title: 问题反馈
|
||||
description: 问题反馈渠道及指南
|
||||
---
|
||||
|
||||
:::info
|
||||
如果您在使用过程中遇到了什么问题,您可以通过下面的方式反馈,但请尽量按照要求提出反馈。
|
||||
:::
|
||||
|
||||
## GitHub Issues
|
||||
|
||||
链接:<https://github.com/halo-dev/halo/issues>
|
||||
|
||||
如果你在使用过程中,遇到了一些 bug 或者需要添加某些新特性,请尽量在 GitHub Issues 进行反馈,这非常有助于我们跟踪解决此问题,您也可以很方便的接收到处理状态。
|
||||
|
||||
建议步骤:
|
||||
|
||||
1. 在 [Issues 列表](https://github.com/halo-dev/halo/issues) 搜索相关问题,看看是否有其他人已经提到了此问题。
|
||||
2. 如果当前还没有人遇到您类似的问题,那么请点击右上角的 `New issue` 按钮创建新的 issue。
|
||||
3. 选择正确的反馈类型。
|
||||
4. 请尽可能详细的按照模板填写内容。
|
||||
5. 点击 `Submit new issue` 提交 issue。
|
||||
|
||||
## Halo 官方社区
|
||||
|
||||
链接:<https://bbs.halo.run>
|
||||
|
||||
此平台主要目的用于与其他 Halo 用户进行交流。但如果您对 GitHub 不是很熟悉或者没有账号,您也可以在此平台进行反馈。
|
@ -1,36 +0,0 @@
|
||||
---
|
||||
title: 系统结构
|
||||
description: Halo 项目的构成
|
||||
---
|
||||
|
||||
[Halo](https://github.com/halo-dev/halo) 博客系统分为以下四个部分:
|
||||
|
||||
| 项目名称 | 简介 |
|
||||
| :------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------- |
|
||||
| [halo](https://github.com/halo-dev/halo) | 提供整个系统的服务,采用 [Spring Boot](https://spring.io/) 开发 |
|
||||
| [halo-admin](https://github.com/halo-dev/halo-admin) | 负责后台管理的渲染,采用 [Vue](https://vuejs.org/) 开发,已集成在 Halo 运行包内,无需独立部署。 |
|
||||
| [halo-comment](https://github.com/halo-dev/halo-comment) | 评论插件,采用 [Vue](https://vuejs.org/) 开发,在主题中运行方式引入构建好的 `JavaScript` 文件即可 |
|
||||
| [halo-theme-\*](https://github.com/halo-dev) | 主题项目集,采用 [FreeMarker](https://freemarker.apache.org/) 模板引擎编写,需要包含一些特殊的配置才能够被 halo 所使用 |
|
||||
|
||||
## 自定义配置
|
||||
|
||||
> 为什么要提前讲自定义配置呢?是因为在这里让大家了解到 `Halo` 的`配置方式`,以及`配置优先级`,不至于未来运行项目的时候不知道如何优雅地修改配置。
|
||||
|
||||
`Halo` 配置目录优先级如下(从上到下优先级越来越小,上层的配置将会覆盖下层):
|
||||
|
||||
- `Halo` 自定义配置
|
||||
- file:~/.halo/
|
||||
- file:~/.halo-dev/
|
||||
- `Spring Boot` 默认配置
|
||||
- file:./config/
|
||||
- file:./
|
||||
- classpath:/config/
|
||||
- classpath:/
|
||||
|
||||
> 参考: [Application Property Files](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files)
|
||||
|
||||
在开发的时候,希望大家能够在 `~/halo-dev/application.yml` 中进行添加自定义配置。当然后面也会讲到如何用`运行参数` 和 `VM options` 进行控制配置,届时可根据具体情况进行选择。
|
||||
|
||||
:::warning
|
||||
开发的时候,我们不建议直接更改`项目源码`中的所包含的`配置文件`,包括 `application.yml`、`application-dev.yml`、`application-test.yml` 和 `application-user.yml`。
|
||||
:::
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: 资源下载
|
||||
description: 目前所有与 Halo 相关的下载地址
|
||||
---
|
||||
|
||||
## GitHub
|
||||
|
||||
:::note
|
||||
如果您的服务器在海外,推荐从 GitHub 下载。
|
||||
:::
|
||||
|
||||
- [运行包](https://github.com/halo-dev/halo/releases)
|
||||
- [配置文件](https://github.com/halo-dev/halo-common)
|
||||
|
||||
## 官方镜像源
|
||||
|
||||
- [https://dl.halo.run](https://dl.halo.run)
|
||||
|
||||
此镜像源由 [Nova Kwok](https://nova.moe/) 提供并维护。
|
||||
|
||||
## 三方镜像源
|
||||
|
||||
- [https://halo.cary.tech](https://halo.cary.tech)
|
||||
|
||||
此镜像源由 [新逸Cary](https://blog.xinac.cn) 提供并维护。
|
@ -1,15 +0,0 @@
|
||||
---
|
||||
title: 三方指南
|
||||
---
|
||||
|
||||
:::tip
|
||||
此类指南或教程均来自第三方或者网友提供,我们不能一直保证其具有有效性,请参考的时候仔细甄别。另外,如果您有写类似的教程,也可以[联系我们](mailto:hi@halo.run)放在下方。
|
||||
:::
|
||||
|
||||
- [Halo 博客安装教程,一款优秀的 Java 开源博客系统](https://www.cnblogs.com/bronya0/p/14198512.html)
|
||||
- [如何用服务器优雅地搭建一个博客—Hello,Halo!](https://www.bilibili.com/video/BV1JN411Q7Na/)
|
||||
- [Halo+云服务器+Nginx反向代理实现个人博客搭建](https://yusart.xyz/archives/halo%E4%B8%AA%E4%BA%BA%E5%8D%9A%E5%AE%A2%E6%90%AD%E5%BB%BA)
|
||||
- [如何在 Windows 下搭建 Halo](https://ykanade.cn/2021/08/11/HaloInWindows/)
|
||||
- [Halo 博客建站记录](https://catchersun.cn/archives/halo%E5%8D%9A%E5%AE%A2%E5%BB%BA%E7%AB%99%E8%AE%B0%E5%BD%95)
|
||||
- [Windows下搭建halo并配置nginx与SSL](https://blog.shikangsi.cn/archives/halo-windows)
|
||||
- [Linux环境下如何分布式部署Halo](https://luoxx.top/archives/halo-distributed-deploy)
|
@ -1,16 +0,0 @@
|
||||
---
|
||||
title: 关于文档
|
||||
description: 关于本文档站点的一些说明
|
||||
---
|
||||
|
||||
:::note
|
||||
此文档使用 [Docusaurus](https://docusaurus.io/) 搭建,感谢 [Docusaurus](https://github.com/facebook/docusaurus) 社区所做的贡献。
|
||||
:::
|
||||
|
||||
## 参与贡献
|
||||
|
||||
:::tip
|
||||
如果你发现文档中有不正确或者需要添加的内容,非常欢迎参与到文档编辑当中。
|
||||
:::
|
||||
|
||||
当前文档的仓库地址为 [halo-dev/docs](https://github.com/halo-dev/docs) ,所以你可以 fork 此仓库,修改之后提交 `Pull request` 等待我们合并即可。
|
@ -1,28 +0,0 @@
|
||||
---
|
||||
title: 问题反馈
|
||||
description: 问题反馈渠道及指南
|
||||
---
|
||||
|
||||
:::info
|
||||
如果您在使用过程中遇到了什么问题,您可以通过下面的方式反馈,但请尽量按照要求提出反馈。
|
||||
:::
|
||||
|
||||
## GitHub Issues
|
||||
|
||||
链接:<https://github.com/halo-dev/halo/issues>
|
||||
|
||||
如果你在使用过程中,遇到了一些 bug 或者需要添加某些新特性,请尽量在 GitHub Issues 进行反馈,这非常有助于我们跟踪解决此问题,您也可以很方便的接收到处理状态。
|
||||
|
||||
建议步骤:
|
||||
|
||||
1. 在 [Issues 列表](https://github.com/halo-dev/halo/issues) 搜索相关问题,看看是否有其他人已经提到了此问题。
|
||||
2. 如果当前还没有人遇到您类似的问题,那么请点击右上角的 `New issue` 按钮创建新的 issue。
|
||||
3. 选择正确的反馈类型。
|
||||
4. 请尽可能详细的按照模板填写内容。
|
||||
5. 点击 `Submit new issue` 提交 issue。
|
||||
|
||||
## Halo 官方社区
|
||||
|
||||
链接:<https://bbs.halo.run>
|
||||
|
||||
此平台主要目的用于与其他 Halo 用户进行交流。但如果您对 GitHub 不是很熟悉或者没有账号,您也可以在此平台进行反馈。
|
@ -1,36 +0,0 @@
|
||||
---
|
||||
title: 系统结构
|
||||
description: Halo 项目的构成
|
||||
---
|
||||
|
||||
[Halo](https://github.com/halo-dev/halo) 博客系统分为以下四个部分:
|
||||
|
||||
| 项目名称 | 简介 |
|
||||
| :------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------- |
|
||||
| [halo](https://github.com/halo-dev/halo) | 提供整个系统的服务,采用 [Spring Boot](https://spring.io/) 开发 |
|
||||
| [halo-admin](https://github.com/halo-dev/halo-admin) | 负责后台管理的渲染,采用 [Vue](https://vuejs.org/) 开发,已集成在 Halo 运行包内,无需独立部署。 |
|
||||
| [halo-comment](https://github.com/halo-dev/halo-comment) | 评论插件,采用 [Vue](https://vuejs.org/) 开发,在主题中运行方式引入构建好的 `JavaScript` 文件即可 |
|
||||
| [halo-theme-\*](https://github.com/halo-dev) | 主题项目集,采用 [FreeMarker](https://freemarker.apache.org/) 模板引擎编写,需要包含一些特殊的配置才能够被 halo 所使用 |
|
||||
|
||||
## 自定义配置
|
||||
|
||||
> 为什么要提前讲自定义配置呢?是因为在这里让大家了解到 `Halo` 的`配置方式`,以及`配置优先级`,不至于未来运行项目的时候不知道如何优雅地修改配置。
|
||||
|
||||
`Halo` 配置目录优先级如下(从上到下优先级越来越小,上层的配置将会覆盖下层):
|
||||
|
||||
- `Halo` 自定义配置
|
||||
- file:~/.halo/
|
||||
- file:~/.halo-dev/
|
||||
- `Spring Boot` 默认配置
|
||||
- file:./config/
|
||||
- file:./
|
||||
- classpath:/config/
|
||||
- classpath:/
|
||||
|
||||
> 参考: [Application Property Files](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config-application-property-files)
|
||||
|
||||
在开发的时候,希望大家能够在 `~/halo-dev/application.yml` 中进行添加自定义配置。当然后面也会讲到如何用`运行参数` 和 `VM options` 进行控制配置,届时可根据具体情况进行选择。
|
||||
|
||||
:::warning
|
||||
开发的时候,我们不建议直接更改`项目源码`中的所包含的`配置文件`,包括 `application.yml`、`application-dev.yml`、`application-test.yml` 和 `application-user.yml`。
|
||||
:::
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue