pc5kflswa
/
docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix cases (#66)

Browse Source 
Signed-off-by: Ryan Wang <i@ryanc.cc>
JohnNiang-patch-1
Ryan Wang 3 years ago committed by GitHub
parent 5a2a4ccad7
commit dcf872a0dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
43 changed files with 87 additions and 87 deletions
Show Stats Download Patch File Download Diff File

6
docs/developer-guide/core/prepare.md
Unescape View File

@ -19,16 +19,16 @@ description: 开发环境的一些说明
## 克隆项目（Optional）
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `Github 用户名`。
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `GitHub 用户名`。
```bash
git clone --recursive https://github.com/halo-dev/halo
// 如果你在 Github 上已经添加了你的 ssh key，请使用以下命令进行 clone：
// 如果你在 GitHub 上已经添加了你的 ssh key，请使用以下命令进行 clone：
git clone --recursive git@github.com:halo-dev/halo.git
```
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `Github` 了。
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `GitHub` 了。
## 导入项目

4
docs/developer-guide/core/structure.md
Unescape View File

@ -9,8 +9,8 @@ description: 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-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 所使用 |
## 自定义配置

2
docs/developer-guide/theme/global-variable.md
Unescape View File

@ -153,7 +153,7 @@ ${atom_url!}
如：`https://yourdomain/atom.xml`
## Xml 格式的网站地图地址
## XML 格式的网站地图地址
```html
${sitemap_xml_url!}

8
docs/developer-guide/theme/prepare.md
Unescape View File

@ -4,7 +4,7 @@ description: 主题开发的环境搭建
---
:::info
Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先阅读一遍 Freemarker 的相关文档：<https://freemarker.apache.org>。
Halo 的模板引擎为 FreeMarker，建议在开发 Halo 的主题之前，先阅读一遍 FreeMarker 的相关文档：<https://freemarker.apache.org>。
:::
## 搭建开发环境
@ -13,7 +13,7 @@ Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先
Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，或者直接下载打包好的程序启动，如下步骤：
1. 从 [Github release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
1. 从 [GitHub release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
2. 在终端中执行 `java -jar halo.jar --spring.profiles.active=dev`
启动完成之后，在电脑的用户目录即可看到 `halo-dev` 文件夹。
@ -21,7 +21,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 新建主题
1. 在 `~/halo-dev/templates/themes` 下新建一个文件夹，该文件夹就是你所新建的主题目录。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [Freemarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [FreeMarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
:::info
我们同样为 Halo 主题开发了一个 `Visual Studio Code` Snippets 扩展，以简化一些操作，但目前处于 beta 状态，有需要的可以试试 [Halo theme develop Snippets](https://marketplace.visualstudio.com/items?itemName=halo-dev.halo-theme-dev-snippets-for-vs-code)。
@ -30,7 +30,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 开发约定
- 主题目录下必须存在 `theme.yaml（主题描述文件）`，`settings.yaml（主题配置文件）`，相关格式在后面会详细讲解。
- 如果要开源到 Github 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 如果要开源到 GitHub 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 所有模板文件的后缀为 `.ftl`。
- 主题目录需要以 `screenshot.png` 命名的预览图片，以供后台展示。

2
docs/getting-started/downloads.md
Unescape View File

@ -3,7 +3,7 @@ title: 资源下载
description: 目前所有与 Halo 相关的下载地址
---
## Github
## GitHub
:::note
如果您的服务器在海外，推荐从 GitHub 下载。

6
docs/getting-started/install/other/docker-compose.md
Unescape View File

@ -29,7 +29,7 @@ vim application.yaml
4. 创建 `docker-compose.yaml`
** Halo 基础版本**
仅创建 Halo 实例：
```yaml
version: "3"
@ -51,7 +51,7 @@ services:
您可以前往 <https://hub.docker.com/r/halohub/halo> 查看最新版本镜像，我们推荐使用具体版本号的镜像，但也提供了 `latest` 标签的镜像，它始终是最新的。
:::
** Halo + MySQL + Redis **
创建 Halo + MySQL + Redis 的实例：
如果您需要使用自部署的 `MySQL` 和 `Redis`，可参考如下的 `docker-compose.yaml`：
@ -121,7 +121,6 @@ networks:
- subnet: 172.19.0.0/16
```
:::info
注意，如果您使用了自部署的 `MySQL` 和 `Redis`，由于 `Halo` 启动时并不会主动创建数据库或者 `schema` ，所以您应该提前创建好 `init.sql` 并且同步更改 `application.yaml` 中的数据源地址和 `cache` 选项。
:::
@ -159,6 +158,7 @@ halo:
# memory or level or redis
cache: redis
```
5. 启动 Halo 服务
```bash

2
docs/getting-started/prepare.md
Unescape View File

@ -66,7 +66,7 @@ create database halodb character set utf8mb4 collate utf8mb4_bin;
后续的文档中，我们会使用 wget 为例，用于下载所需要的文件，所以请确保服务器已经安装好了这个软件包。当然，下载文件不限制工具，如果你对其他工具熟悉，可以忽略。
#### Vim（可选）
#### VIM（可选）
后续的文档中，我们会使用 vim 为例，用于修改一些必要的配置文件，所以同样请确保服务器已经安装了这个软件包。当前，修改文档也不限制工具，如果你对其他编辑软件熟悉，也可以忽略。

4
docs/user-guide/config.md
Unescape View File

@ -29,7 +29,7 @@ description: 系统功能的相关配置说明
很多人反映评论中自己的头像不显示，其实评论部分调用的头像并不是在个人资料中设置的那个，而是 `Gravatar`。所以这一点怪我，从 Halo 发布至今我都没有说明这个事情。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `Github`，`Gitlab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `GitHub`，`GitLab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
## 设置用户头像/Logo/Favicon
@ -146,7 +146,7 @@ A：诸如百度统计，CNZZ，Google Analytics。可以非常详细的统计
登录到后台之后，进入 外观 -> 主题，在后下角有一个按钮，点击之后选择 `安装主题`。系统提供的两种安装方式。
1. 第一种，远程拉取。你只需要把主题的 Github 地址复制进去点击下载即可。
1. 第一种，远程拉取。你只需要把主题的 GitHub 地址复制进去点击下载即可。
2. 第二种，本地上传，你需要将主题安装包（releases）下载到本地，然后选择 `本地上传` 点击选择你下载好的主题即可。
> 一般情况下，推荐第二种，第一种一般安装的为开发版本，建议谨慎使用。

6
versioned_docs/version-1.4.15/developer-guide/core/prepare.md
Unescape View File

@ -19,16 +19,16 @@ description: 开发环境的一些说明
## 克隆项目（Optional）
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `Github 用户名`。
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `GitHub 用户名`。
```bash
git clone --recursive https://github.com/halo-dev/halo
// 如果你在 Github 上已经添加了你的 ssh key，请使用以下命令进行 clone：
// 如果你在 GitHub 上已经添加了你的 ssh key，请使用以下命令进行 clone：
git clone --recursive git@github.com:halo-dev/halo.git
```
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `Github` 了。
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `GitHub` 了。
## 导入项目

4
versioned_docs/version-1.4.15/developer-guide/core/structure.md
Unescape View File

@ -9,8 +9,8 @@ description: 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-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 所使用 |
## 自定义配置

2
versioned_docs/version-1.4.15/developer-guide/theme/global-variable.md
Unescape View File

@ -155,7 +155,7 @@ ${atom_url!}
如：`https://yourdomain/atom.xml`
## Xml 格式的网站地图地址
## XML 格式的网站地图地址
```
${sitemap_xml_url!}

8
versioned_docs/version-1.4.15/developer-guide/theme/prepare.md
Unescape View File

@ -4,7 +4,7 @@ description: 主题开发的环境搭建
---
:::info
Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先阅读一遍 Freemarker 的相关文档：<https://freemarker.apache.org>。
Halo 的模板引擎为 FreeMarker，建议在开发 Halo 的主题之前，先阅读一遍 FreeMarker 的相关文档：<https://freemarker.apache.org>。
:::
## 搭建开发环境
@ -13,7 +13,7 @@ Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先
Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，或者直接下载打包好的程序启动，如下步骤：
1. 从 [Github release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
1. 从 [GitHub release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
2. 在终端中执行 `java -jar halo.jar --spring.profiles.active=dev`
启动完成之后，在电脑的用户目录即可看到 `halo-dev` 文件夹。
@ -21,7 +21,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 新建主题
1. 在 `~/halo-dev/templates/themes` 下新建一个文件夹，该文件夹就是你所新建的主题目录。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [Freemarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [FreeMarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
:::info
我们同样为 Halo 主题开发了一个 `Visual Studio Code` Snippets 扩展，以简化一些操作，但目前处于 beta 状态，有需要的可以试试 [Halo theme develop Snippets](https://marketplace.visualstudio.com/items?itemName=halo-dev.halo-theme-dev-snippets-for-vs-code)。
@ -30,7 +30,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 开发约定
- 主题目录下必须存在 `theme.yaml（主题描述文件）`，`settings.yaml（主题配置文件）`，相关格式在后面会详细讲解。
- 如果要开源到 Github 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 如果要开源到 GitHub 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 所有模板文件的后缀为 `.ftl`。
- 主题目录需要以 `screenshot.png` 命名的预览图片，以供后台展示。

2
versioned_docs/version-1.4.15/getting-started/downloads.md
Unescape View File

@ -3,7 +3,7 @@ title: 资源下载
description: 目前所有与 Halo 相关的下载地址
---
## Github
## GitHub
:::note
如果您的服务器在海外，推荐从 GitHub 下载。

2
versioned_docs/version-1.4.15/getting-started/prepare.md
Unescape View File

@ -66,7 +66,7 @@ create database halodb character set utf8mb4 collate utf8mb4_bin;
后续的文档中，我们会使用 wget 为例，用于下载所需要的文件，所以请确保服务器已经安装好了这个软件包。当然，下载文件不限制工具，如果你对其他工具熟悉，可以忽略。
#### Vim（可选）
#### VIM（可选）
后续的文档中，我们会使用 vim 为例，用于修改一些必要的配置文件，所以同样请确保服务器已经安装了这个软件包。当前，修改文档也不限制工具，如果你对其他编辑软件熟悉，也可以忽略。

4
versioned_docs/version-1.4.15/user-guide/config.md
Unescape View File

@ -29,7 +29,7 @@ description: 系统功能的相关配置说明
很多人反映评论中自己的头像不显示，其实评论部分调用的头像并不是在个人资料中设置的那个，而是 `Gravatar`。所以这一点怪我，从 Halo 发布至今我都没有说明这个事情。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `Github`，`Gitlab`，`V2ex` 等。所以点击 https://cn.gravatar.com/ 注册一个吧。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `GitHub`，`GitLab`，`V2ex` 等。所以点击 https://cn.gravatar.com/ 注册一个吧。
## 设置用户头像/Logo/Favicon
@ -146,7 +146,7 @@ A：诸如百度统计，CNZZ，Google Analytics。可以非常详细的统计
登录到后台之后，进入 外观 -> 主题，在后下角有一个按钮，点击之后选择 `安装主题`。系统提供的两种安装方式。
1. 第一种，远程拉取。你只需要把主题的 Github 地址复制进去点击下载即可。
1. 第一种，远程拉取。你只需要把主题的 GitHub 地址复制进去点击下载即可。
2. 第二种，本地上传，你需要将主题安装包（releases）下载到本地，然后选择 `本地上传` 点击选择你下载好的主题即可。
> 一般情况下，推荐第二种，第一种一般安装的为开发版本，建议谨慎使用。

6
versioned_docs/version-1.4.16/developer-guide/core/prepare.md
Unescape View File

@ -19,16 +19,16 @@ description: 开发环境的一些说明
## 克隆项目（Optional）
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `Github 用户名`。
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `GitHub 用户名`。
```bash
git clone --recursive https://github.com/halo-dev/halo
// 如果你在 Github 上已经添加了你的 ssh key，请使用以下命令进行 clone：
// 如果你在 GitHub 上已经添加了你的 ssh key，请使用以下命令进行 clone：
git clone --recursive git@github.com:halo-dev/halo.git
```
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `Github` 了。
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `GitHub` 了。
## 导入项目

4
versioned_docs/version-1.4.16/developer-guide/core/structure.md
Unescape View File

@ -9,8 +9,8 @@ description: 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-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 所使用 |
## 自定义配置

2
versioned_docs/version-1.4.16/developer-guide/theme/global-variable.md
Unescape View File

@ -155,7 +155,7 @@ ${atom_url!}
如：`https://yourdomain/atom.xml`
## Xml 格式的网站地图地址
## XML 格式的网站地图地址
```
${sitemap_xml_url!}

8
versioned_docs/version-1.4.16/developer-guide/theme/prepare.md
Unescape View File

@ -4,7 +4,7 @@ description: 主题开发的环境搭建
---
:::info
Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先阅读一遍 Freemarker 的相关文档：<https://freemarker.apache.org>。
Halo 的模板引擎为 FreeMarker，建议在开发 Halo 的主题之前，先阅读一遍 FreeMarker 的相关文档：<https://freemarker.apache.org>。
:::
## 搭建开发环境
@ -13,7 +13,7 @@ Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先
Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，或者直接下载打包好的程序启动，如下步骤：
1. 从 [Github release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
1. 从 [GitHub release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
2. 在终端中执行 `java -jar halo.jar --spring.profiles.active=dev`
启动完成之后，在电脑的用户目录即可看到 `halo-dev` 文件夹。
@ -21,7 +21,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 新建主题
1. 在 `~/halo-dev/templates/themes` 下新建一个文件夹，该文件夹就是你所新建的主题目录。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [Freemarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [FreeMarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
:::info
我们同样为 Halo 主题开发了一个 `Visual Studio Code` Snippets 扩展，以简化一些操作，但目前处于 beta 状态，有需要的可以试试 [Halo theme develop Snippets](https://marketplace.visualstudio.com/items?itemName=halo-dev.halo-theme-dev-snippets-for-vs-code)。
@ -30,7 +30,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 开发约定
- 主题目录下必须存在 `theme.yaml（主题描述文件）`，`settings.yaml（主题配置文件）`，相关格式在后面会详细讲解。
- 如果要开源到 Github 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 如果要开源到 GitHub 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 所有模板文件的后缀为 `.ftl`。
- 主题目录需要以 `screenshot.png` 命名的预览图片，以供后台展示。

2
versioned_docs/version-1.4.16/getting-started/downloads.md
Unescape View File

@ -3,7 +3,7 @@ title: 资源下载
description: 目前所有与 Halo 相关的下载地址
---
## Github
## GitHub
:::note
如果您的服务器在海外，推荐从 GitHub 下载。

2
versioned_docs/version-1.4.16/getting-started/prepare.md
Unescape View File

@ -66,7 +66,7 @@ create database halodb character set utf8mb4 collate utf8mb4_bin;
后续的文档中，我们会使用 wget 为例，用于下载所需要的文件，所以请确保服务器已经安装好了这个软件包。当然，下载文件不限制工具，如果你对其他工具熟悉，可以忽略。
#### Vim（可选）
#### VIM（可选）
后续的文档中，我们会使用 vim 为例，用于修改一些必要的配置文件，所以同样请确保服务器已经安装了这个软件包。当前，修改文档也不限制工具，如果你对其他编辑软件熟悉，也可以忽略。

4
versioned_docs/version-1.4.16/user-guide/config.md
Unescape View File

@ -29,7 +29,7 @@ description: 系统功能的相关配置说明
很多人反映评论中自己的头像不显示，其实评论部分调用的头像并不是在个人资料中设置的那个，而是 `Gravatar`。所以这一点怪我，从 Halo 发布至今我都没有说明这个事情。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `Github`，`Gitlab`，`V2ex` 等。所以点击 https://cn.gravatar.com/ 注册一个吧。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `GitHub`，`GitLab`，`V2ex` 等。所以点击 https://cn.gravatar.com/ 注册一个吧。
## 设置用户头像/Logo/Favicon
@ -146,7 +146,7 @@ A：诸如百度统计，CNZZ，Google Analytics。可以非常详细的统计
登录到后台之后，进入 外观 -> 主题，在后下角有一个按钮，点击之后选择 `安装主题`。系统提供的两种安装方式。
1. 第一种，远程拉取。你只需要把主题的 Github 地址复制进去点击下载即可。
1. 第一种，远程拉取。你只需要把主题的 GitHub 地址复制进去点击下载即可。
2. 第二种，本地上传，你需要将主题安装包（releases）下载到本地，然后选择 `本地上传` 点击选择你下载好的主题即可。
> 一般情况下，推荐第二种，第一种一般安装的为开发版本，建议谨慎使用。

6
versioned_docs/version-1.4.17/developer-guide/core/prepare.md
Unescape View File

@ -19,16 +19,16 @@ description: 开发环境的一些说明
## 克隆项目（Optional）
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `Github 用户名`。
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `GitHub 用户名`。
```bash
git clone --recursive https://github.com/halo-dev/halo
// 如果你在 Github 上已经添加了你的 ssh key，请使用以下命令进行 clone：
// 如果你在 GitHub 上已经添加了你的 ssh key，请使用以下命令进行 clone：
git clone --recursive git@github.com:halo-dev/halo.git
```
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `Github` 了。
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `GitHub` 了。
## 导入项目

4
versioned_docs/version-1.4.17/developer-guide/core/structure.md
Unescape View File

@ -9,8 +9,8 @@ description: 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-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 所使用 |
## 自定义配置

2
versioned_docs/version-1.4.17/developer-guide/theme/global-variable.md
Unescape View File

@ -153,7 +153,7 @@ ${atom_url!}
如：`https://yourdomain/atom.xml`
## Xml 格式的网站地图地址
## XML 格式的网站地图地址
```html
${sitemap_xml_url!}

8
versioned_docs/version-1.4.17/developer-guide/theme/prepare.md
Unescape View File

@ -4,7 +4,7 @@ description: 主题开发的环境搭建
---
:::info
Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先阅读一遍 Freemarker 的相关文档：<https://freemarker.apache.org>。
Halo 的模板引擎为 FreeMarker，建议在开发 Halo 的主题之前，先阅读一遍 FreeMarker 的相关文档：<https://freemarker.apache.org>。
:::
## 搭建开发环境
@ -13,7 +13,7 @@ Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先
Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，或者直接下载打包好的程序启动，如下步骤：
1. 从 [Github release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
1. 从 [GitHub release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
2. 在终端中执行 `java -jar halo.jar --spring.profiles.active=dev`
启动完成之后，在电脑的用户目录即可看到 `halo-dev` 文件夹。
@ -21,7 +21,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 新建主题
1. 在 `~/halo-dev/templates/themes` 下新建一个文件夹，该文件夹就是你所新建的主题目录。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [Freemarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [FreeMarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
:::info
我们同样为 Halo 主题开发了一个 `Visual Studio Code` Snippets 扩展，以简化一些操作，但目前处于 beta 状态，有需要的可以试试 [Halo theme develop Snippets](https://marketplace.visualstudio.com/items?itemName=halo-dev.halo-theme-dev-snippets-for-vs-code)。
@ -30,7 +30,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 开发约定
- 主题目录下必须存在 `theme.yaml（主题描述文件）`，`settings.yaml（主题配置文件）`，相关格式在后面会详细讲解。
- 如果要开源到 Github 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 如果要开源到 GitHub 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 所有模板文件的后缀为 `.ftl`。
- 主题目录需要以 `screenshot.png` 命名的预览图片，以供后台展示。

2
versioned_docs/version-1.4.17/getting-started/downloads.md
Unescape View File

@ -3,7 +3,7 @@ title: 资源下载
description: 目前所有与 Halo 相关的下载地址
---
## Github
## GitHub
:::note
如果您的服务器在海外，推荐从 GitHub 下载。

2
versioned_docs/version-1.4.17/getting-started/prepare.md
Unescape View File

@ -66,7 +66,7 @@ create database halodb character set utf8mb4 collate utf8mb4_bin;
后续的文档中，我们会使用 wget 为例，用于下载所需要的文件，所以请确保服务器已经安装好了这个软件包。当然，下载文件不限制工具，如果你对其他工具熟悉，可以忽略。
#### Vim（可选）
#### VIM（可选）
后续的文档中，我们会使用 vim 为例，用于修改一些必要的配置文件，所以同样请确保服务器已经安装了这个软件包。当前，修改文档也不限制工具，如果你对其他编辑软件熟悉，也可以忽略。

4
versioned_docs/version-1.4.17/user-guide/config.md
Unescape View File

@ -29,7 +29,7 @@ description: 系统功能的相关配置说明
很多人反映评论中自己的头像不显示，其实评论部分调用的头像并不是在个人资料中设置的那个，而是 `Gravatar`。所以这一点怪我，从 Halo 发布至今我都没有说明这个事情。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `Github`，`Gitlab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `GitHub`，`GitLab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
## 设置用户头像/Logo/Favicon
@ -146,7 +146,7 @@ A：诸如百度统计，CNZZ，Google Analytics。可以非常详细的统计
登录到后台之后，进入 外观 -> 主题，在后下角有一个按钮，点击之后选择 `安装主题`。系统提供的两种安装方式。
1. 第一种，远程拉取。你只需要把主题的 Github 地址复制进去点击下载即可。
1. 第一种，远程拉取。你只需要把主题的 GitHub 地址复制进去点击下载即可。
2. 第二种，本地上传，你需要将主题安装包（releases）下载到本地，然后选择 `本地上传` 点击选择你下载好的主题即可。
> 一般情况下，推荐第二种，第一种一般安装的为开发版本，建议谨慎使用。

6
versioned_docs/version-1.5.0/developer-guide/core/prepare.md
Unescape View File

@ -19,16 +19,16 @@ description: 开发环境的一些说明
## 克隆项目（Optional）
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `Github 用户名`。
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `GitHub 用户名`。
```bash
git clone --recursive https://github.com/halo-dev/halo
// 如果你在 Github 上已经添加了你的 ssh key，请使用以下命令进行 clone：
// 如果你在 GitHub 上已经添加了你的 ssh key，请使用以下命令进行 clone：
git clone --recursive git@github.com:halo-dev/halo.git
```
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `Github` 了。
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `GitHub` 了。
## 导入项目

4
versioned_docs/version-1.5.0/developer-guide/core/structure.md
Unescape View File

@ -9,8 +9,8 @@ description: 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-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 所使用 |
## 自定义配置

2
versioned_docs/version-1.5.0/developer-guide/theme/global-variable.md
Unescape View File

@ -153,7 +153,7 @@ ${atom_url!}
如：`https://yourdomain/atom.xml`
## Xml 格式的网站地图地址
## XML 格式的网站地图地址
```html
${sitemap_xml_url!}

8
versioned_docs/version-1.5.0/developer-guide/theme/prepare.md
Unescape View File

@ -4,7 +4,7 @@ description: 主题开发的环境搭建
---
:::info
Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先阅读一遍 Freemarker 的相关文档：<https://freemarker.apache.org>。
Halo 的模板引擎为 FreeMarker，建议在开发 Halo 的主题之前，先阅读一遍 FreeMarker 的相关文档：<https://freemarker.apache.org>。
:::
## 搭建开发环境
@ -13,7 +13,7 @@ Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先
Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，或者直接下载打包好的程序启动，如下步骤：
1. 从 [Github release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
1. 从 [GitHub release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
2. 在终端中执行 `java -jar halo.jar --spring.profiles.active=dev`
启动完成之后，在电脑的用户目录即可看到 `halo-dev` 文件夹。
@ -21,7 +21,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 新建主题
1. 在 `~/halo-dev/templates/themes` 下新建一个文件夹，该文件夹就是你所新建的主题目录。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [Freemarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [FreeMarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
:::info
我们同样为 Halo 主题开发了一个 `Visual Studio Code` Snippets 扩展，以简化一些操作，但目前处于 beta 状态，有需要的可以试试 [Halo theme develop Snippets](https://marketplace.visualstudio.com/items?itemName=halo-dev.halo-theme-dev-snippets-for-vs-code)。
@ -30,7 +30,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 开发约定
- 主题目录下必须存在 `theme.yaml（主题描述文件）`，`settings.yaml（主题配置文件）`，相关格式在后面会详细讲解。
- 如果要开源到 Github 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 如果要开源到 GitHub 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 所有模板文件的后缀为 `.ftl`。
- 主题目录需要以 `screenshot.png` 命名的预览图片，以供后台展示。

2
versioned_docs/version-1.5.0/getting-started/downloads.md
Unescape View File

@ -3,7 +3,7 @@ title: 资源下载
description: 目前所有与 Halo 相关的下载地址
---
## Github
## GitHub
:::note
如果您的服务器在海外，推荐从 GitHub 下载。

2
versioned_docs/version-1.5.0/getting-started/prepare.md
Unescape View File

@ -66,7 +66,7 @@ create database halodb character set utf8mb4 collate utf8mb4_bin;
后续的文档中，我们会使用 wget 为例，用于下载所需要的文件，所以请确保服务器已经安装好了这个软件包。当然，下载文件不限制工具，如果你对其他工具熟悉，可以忽略。
#### Vim（可选）
#### VIM（可选）
后续的文档中，我们会使用 vim 为例，用于修改一些必要的配置文件，所以同样请确保服务器已经安装了这个软件包。当前，修改文档也不限制工具，如果你对其他编辑软件熟悉，也可以忽略。

4
versioned_docs/version-1.5.0/user-guide/config.md
Unescape View File

@ -29,7 +29,7 @@ description: 系统功能的相关配置说明
很多人反映评论中自己的头像不显示，其实评论部分调用的头像并不是在个人资料中设置的那个，而是 `Gravatar`。所以这一点怪我，从 Halo 发布至今我都没有说明这个事情。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `Github`，`Gitlab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `GitHub`，`GitLab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
## 设置用户头像/Logo/Favicon
@ -146,7 +146,7 @@ A：诸如百度统计，CNZZ，Google Analytics。可以非常详细的统计
登录到后台之后，进入 外观 -> 主题，在后下角有一个按钮，点击之后选择 `安装主题`。系统提供的两种安装方式。
1. 第一种，远程拉取。你只需要把主题的 Github 地址复制进去点击下载即可。
1. 第一种，远程拉取。你只需要把主题的 GitHub 地址复制进去点击下载即可。
2. 第二种，本地上传，你需要将主题安装包（releases）下载到本地，然后选择 `本地上传` 点击选择你下载好的主题即可。
> 一般情况下，推荐第二种，第一种一般安装的为开发版本，建议谨慎使用。

6
versioned_docs/version-1.5.1/developer-guide/core/prepare.md
Unescape View File

@ -19,16 +19,16 @@ description: 开发环境的一些说明
## 克隆项目（Optional）
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `Github 用户名`。
如果你已经 `fork` 了 [`Halo`](https://github.com/halo-dev/halo)，请将以下命令中的 `halo-dev` 替换为你的 `GitHub 用户名`。
```bash
git clone --recursive https://github.com/halo-dev/halo
// 如果你在 Github 上已经添加了你的 ssh key，请使用以下命令进行 clone：
// 如果你在 GitHub 上已经添加了你的 ssh key，请使用以下命令进行 clone：
git clone --recursive git@github.com:halo-dev/halo.git
```
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `Github` 了。
这里推荐使用第二种方式进行克隆，这样每次提交代码的时候，就不会提示登录 `GitHub` 了。
## 导入项目

4
versioned_docs/version-1.5.1/developer-guide/core/structure.md
Unescape View File

@ -9,8 +9,8 @@ description: 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-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 所使用 |
## 自定义配置

2
versioned_docs/version-1.5.1/developer-guide/theme/global-variable.md
Unescape View File

@ -153,7 +153,7 @@ ${atom_url!}
如：`https://yourdomain/atom.xml`
## Xml 格式的网站地图地址
## XML 格式的网站地图地址
```html
${sitemap_xml_url!}

8
versioned_docs/version-1.5.1/developer-guide/theme/prepare.md
Unescape View File

@ -4,7 +4,7 @@ description: 主题开发的环境搭建
---
:::info
Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先阅读一遍 Freemarker 的相关文档：<https://freemarker.apache.org>。
Halo 的模板引擎为 FreeMarker，建议在开发 Halo 的主题之前，先阅读一遍 FreeMarker 的相关文档：<https://freemarker.apache.org>。
:::
## 搭建开发环境
@ -13,7 +13,7 @@ Halo 的模板引擎为 Freemarker，建议在开发 Halo 的主题之前，先
Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，或者直接下载打包好的程序启动，如下步骤：
1. 从 [Github release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
1. 从 [GitHub release](https://github.com/halo-dev/halo/releases) 或者 [https://dl.halo.run](https://dl.halo.run) 下载最新的运行包。
2. 在终端中执行 `java -jar halo.jar --spring.profiles.active=dev`
启动完成之后，在电脑的用户目录即可看到 `halo-dev` 文件夹。
@ -21,7 +21,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 新建主题
1. 在 `~/halo-dev/templates/themes` 下新建一个文件夹，该文件夹就是你所新建的主题目录。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [Freemarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
2. 使用你熟悉的编辑器打开你所新建的主题目录，这里我们推荐使用 [Visual Studio Code](https://code.visualstudio.com)，并安装 [FreeMarker](https://marketplace.visualstudio.com/items?itemName=dcortes92.FreeMarker) 扩展。
:::info
我们同样为 Halo 主题开发了一个 `Visual Studio Code` Snippets 扩展，以简化一些操作，但目前处于 beta 状态，有需要的可以试试 [Halo theme develop Snippets](https://marketplace.visualstudio.com/items?itemName=halo-dev.halo-theme-dev-snippets-for-vs-code)。
@ -30,7 +30,7 @@ Halo 的运行可参考上述 [系统开发](/developer-guide/core/prepare)，
## 开发约定
- 主题目录下必须存在 `theme.yaml（主题描述文件）`，`settings.yaml（主题配置文件）`，相关格式在后面会详细讲解。
- 如果要开源到 Github 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 如果要开源到 GitHub 我们建议将仓库名设置为 `halo-theme-主题名`，并设置仓库的 `topic` 为 `halo` 和 `halo-theme`，这样可以方便使用者搜索。
- 所有模板文件的后缀为 `.ftl`。
- 主题目录需要以 `screenshot.png` 命名的预览图片，以供后台展示。

2
versioned_docs/version-1.5.1/getting-started/downloads.md
Unescape View File

@ -3,7 +3,7 @@ title: 资源下载
description: 目前所有与 Halo 相关的下载地址
---
## Github
## GitHub
:::note
如果您的服务器在海外，推荐从 GitHub 下载。

2
versioned_docs/version-1.5.1/getting-started/prepare.md
Unescape View File

@ -66,7 +66,7 @@ create database halodb character set utf8mb4 collate utf8mb4_bin;
后续的文档中，我们会使用 wget 为例，用于下载所需要的文件，所以请确保服务器已经安装好了这个软件包。当然，下载文件不限制工具，如果你对其他工具熟悉，可以忽略。
#### Vim（可选）
#### VIM（可选）
后续的文档中，我们会使用 vim 为例，用于修改一些必要的配置文件，所以同样请确保服务器已经安装了这个软件包。当前，修改文档也不限制工具，如果你对其他编辑软件熟悉，也可以忽略。

4
versioned_docs/version-1.5.1/user-guide/config.md
Unescape View File

@ -29,7 +29,7 @@ description: 系统功能的相关配置说明
很多人反映评论中自己的头像不显示，其实评论部分调用的头像并不是在个人资料中设置的那个，而是 `Gravatar`。所以这一点怪我，从 Halo 发布至今我都没有说明这个事情。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `Github`，`Gitlab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
至于什么是 `Gravatar`，引用 `Gravatar` 官方的说明：`全球公认的头像`。这可不是在吹牛，因为只要接入了 Gravatar 的网站，你在网站上使用在 Gravatar 注册的邮箱之后，都会显示你设置的头像，而不需要额外设置。比较出名的网站有 `GitHub`，`GitLab`，`V2ex` 等。所以点击 <https://cn.gravatar.com/> 注册一个吧。
## 设置用户头像/Logo/Favicon
@ -146,7 +146,7 @@ A：诸如百度统计，CNZZ，Google Analytics。可以非常详细的统计
登录到后台之后，进入 外观 -> 主题，在后下角有一个按钮，点击之后选择 `安装主题`。系统提供的两种安装方式。
1. 第一种，远程拉取。你只需要把主题的 Github 地址复制进去点击下载即可。
1. 第一种，远程拉取。你只需要把主题的 GitHub 地址复制进去点击下载即可。
2. 第二种，本地上传，你需要将主题安装包（releases）下载到本地，然后选择 `本地上传` 点击选择你下载好的主题即可。
> 一般情况下，推荐第二种，第一种一般安装的为开发版本，建议谨慎使用。

Write Preview
Loading…
Cancel
Save