Ryan Wang
7e097c93f9
chore: refine plugin development documentation ( #503 )
...
* chore: refine plugin development documentation
Signed-off-by: Ryan Wang <i@ryanc.cc >
* chore: refine plugin development documentation
Signed-off-by: Ryan Wang <i@ryanc.cc >
* chore: refine plugin development documentation
Signed-off-by: Ryan Wang <i@ryanc.cc >
---------
Signed-off-by: Ryan Wang <i@ryanc.cc >
2025-06-21 20:47:16 +08:00
Ryan Wang
9df9374ce3
docs: update documentations for 2.21 ( #502 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc >
2025-06-15 14:49:12 +08:00
Ryan Wang
46143f9c8b
chore: bump docusaurus to 3.8 ( #498 )
2025-05-27 19:15:18 +08:00
Ryan Wang
0a7cdc5171
chore: remove umami tracking script ( #495 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc >
2025-05-15 11:08:16 +08:00
Ryan Wang
098e9b339b
chore: add rybbit tracking script ( #494 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc >
2025-05-14 15:08:02 +08:00
Ryan Wang
aa466d9b72
chore: bump docusaurus to canary verison ( #428 )
...
Support for building projects via rspack has been added in the latest Canary version of Docusaurus, which significantly improves compilation speed.
```bash
❯ hyperfine --prepare 'pnpm clear' --runs 5 'DOCUSAURUS_FASTER=false pnpm build' 'DOCUSAURUS_FASTER=true pnpm build'
Benchmark 1: DOCUSAURUS_FASTER=false pnpm build
Time (mean ± σ): 70.715 s ± 17.150 s [User: 134.096 s, System: 31.651 s]
Range (min … max): 52.330 s … 88.497 s 5 runs
Benchmark 2: DOCUSAURUS_FASTER=true pnpm build
Time (mean ± σ): 30.094 s ± 4.572 s [User: 64.061 s, System: 28.384 s]
Range (min … max): 25.832 s … 37.655 s 5 runs
Summary
DOCUSAURUS_FASTER=true pnpm build ran
2.35 ± 0.67 times faster than DOCUSAURUS_FASTER=false pnpm build
```
see: https://github.com/facebook/docusaurus/issues/10556#issuecomment-2407671873
```release-note
None
```
2024-10-31 09:48:01 +00:00
guqing
0b1d4596d5
feat: diagrams can be rendered using Mermaid in a code block ( #458 )
...
### What this PR does?
添加对 Mermaid Diagrams 的支持
```release-note
None
```
2024-10-31 05:28:51 +00:00
Ryan Wang
cd44c8ba89
docs: restructure theme development documentation ( #450 )
...
重构主题开发的部分文档，合并模板路由和模板变量章节。
/kind documentation
```release-note
None
```
2024-10-28 08:18:05 +00:00
Ryan Wang
5ef6bc2712
docs: add database creation tips ( #449 )
...
添加创建数据库的提示。
Fixes https://github.com/halo-dev/docs/issues/336
```release-note
None
```
2024-10-28 07:32:04 +00:00
Ryan Wang
5ce83249d2
docs: update halo official website url ( #433 )
...
更新 Halo 官网的地址。
```release-note
None
```
2024-10-15 06:31:21 +00:00
Ryan Wang
06e5cb2d20
chore: remove 2.10~2.15 versions ( #431 )
...
移除 2.10～2.15 的文档，已经将 2.10～2.15 的文档转移到 https://v2.archive-docs.halo.run/
```release-note
None
```
2024-10-15 04:21:21 +00:00
Ryan Wang
9876911e3a
docs: update documentation for Halo 2.20 ( #429 )
...
为 [Halo 2.20](https://github.com/halo-dev/halo/releases/tag/v2.20.0 ) 更新文档。
/kind documentation
```release-note
None
```
2024-10-14 03:33:15 +00:00
Ryan Wang
e431bdc99b
docs: update documentation for Halo 2.18 ( #407 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc >
2024-09-02 14:14:00 +08:00
Ryan Wang
250c0180d7
chore: bump docusaurus version to 3.x ( #395 )
...
升级 Docusaurus 版本至 3.x
参照 https://docusaurus.io/zh-CN/docs/migration/v3 升级指南。
Fixes #394
/kind improvement
```release-note
None
```
2024-08-09 14:12:40 +00:00
Ryan Wang
dd6cc4848a
docs: update documentation for Halo 2.18 ( #389 )
...
为 [Halo 2.18](https://github.com/halo-dev/halo/releases/tag/v2.18.0 ) 更新文档。
/kind documentation
```release-note
None
```
2024-08-01 02:50:10 +00:00
Ryan Wang
9d868fa50e
docs: update documentation for Halo 2.17 ( #378 )
...
为 [Halo 2.17](https://github.com/halo-dev/halo/releases/tag/v2.17.0 ) 更新文档。
/kind documentation
```release-note
None
```
2024-07-02 02:41:22 +00:00
Ryan Wang
7eec30763e
docs: update documentation for Halo 2.16 ( #367 )
...
为 Halo 2.16.0 更新文档。
/kind documentation
```release-note
None
```
2024-06-03 04:45:44 +00:00
Ryan Wang
9420d37857
chore: remove archived docs ( #360 )
...
考虑到此仓库的文档版本逐渐变多，会导致编译过慢，所以这个 PR 移除了 2.0-2.9 的历史版本，并将这些版本部署到了 https://v2.archive-docs.halo.run/
<img width="498" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/64281dc1-28c0-4656-a2fc-10ccc050e2a7 ">
/kind improvement
```release-note
None
```
2024-05-28 11:27:08 +00:00
Ryan Wang
d78a16e217
chore: use swc instead of esbuild ( #359 )
...
使用 swc 代替 esbuild，之前在 https://github.com/halo-dev/docs/pull/358 中引入了 esbuild，但发现在生产构建之后会出现这个问题：
<img width="1912" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/5dcd724d-3876-4e58-b902-1818dd9d1fbd ">
暂时不清楚为什么，使用 swc 测试构建之后没有这个问题。
/kind bug
```release-note
None
```
2024-05-28 05:18:58 +00:00
Ryan Wang
ac0b158b73
chore: use esbuild instead of babel ( #358 )
...
引入 esbuild，提升构建速度。
before:
<img width="777" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/49d28d76-1c10-47c8-ac8c-31b41a31f6bd ">
after:
<img width="888" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/61462a4c-ba66-4612-9363-67e5d394601b ">
/kind improvement
```release-note
None
```
2024-05-28 03:42:57 +00:00
Ryan Wang
b4e637b4b0
chore: use selfhosted-meilisearch as docs search engine ( #357 )
...
使用自建的 Meilisearch 作为文档搜索引擎，代替 Algolia。
/kind improvement
```release-note
None
```
2024-05-28 03:12:58 +00:00
Ryan Wang
846d6c3791
docs: update documentation for Halo 2.15 ( #345 )
...
为 Halo 2.15.0 更新文档。
/kind documentation
```release-note
None
```
2024-04-30 08:14:06 +00:00
Ryan Wang
6e97f3724b
docs: update documentation for Halo 2.14 ( #334 )
...
为 Halo 2.14.0 更新文档。
/kind documentation
```release-note
None
```
2024-04-01 07:28:07 +00:00
Ryan Wang
7dd663136d
docs: update documentation for Halo 2.13 ( #321 )
...
为 Halo 2.13.0 更新文档。
/kind documentation
```release-note
None
```
2024-03-01 04:35:02 +00:00
Ryan Wang
97e0b2b526
refactor: documentation structure ( #310 )
...
重构文档结构，将开发者文档与使用文档分开。
<img width="641" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/baed360c-997b-443c-9a8e-cc53e268b8f4 ">
<img width="766" alt="image" src="https://github.com/halo-dev/docs/assets/21301288/08326aab-d474-4075-bdc9-c628a39ba715 ">
Note: 此改动不造成死链。
```release-note
None
```
2024-02-05 10:00:13 +00:00
Ryan Wang
d0ea59e6e2
docs: update documentation for Halo 2.12 ( #306 )
...
为 Halo 2.12.0 更新文档。
/kind documentation
```release-note
None
```
2024-02-01 03:11:39 +00:00
Ryan Wang
6a253dd896
docs: refactor documentation of plugin development ( #291 )
...
重构和完善插件开发文档。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/253
```release-note
None
```
---------
Signed-off-by: Ryan Wang <i@ryanc.cc >
Co-authored-by: guqing <i@guqing.email >
2024-01-30 16:00:18 +08:00
Ryan Wang
1d97214ad3
chore: remove 1.x documentation ( #303 )
...
移除 1.x 的文档，以及清除一些过时文档。
1.x 所有文档已经被移动到 https://github.com/halo-dev/v1-legacy-docs 并托管在 https://v1.legacy-docs.halo.run
<img width="669" alt="图片" src="https://github.com/halo-dev/docs/assets/21301288/684e4b0e-fc60-44ae-bda1-52fe62c4670d ">
/kind cleanup
```release-note
None
```
2024-01-02 02:38:12 +00:00
Ryan Wang
7e8a8ecb0d
docs: update documentation for Halo 2.11 ( #283 )
...
为 Halo 2.11.0 更新文档。
/kind documentation
```release-note
None
```
2023-12-01 07:00:09 +00:00
Ryan Wang
d80d49e1ac
docs: remove oneinstack related documentations ( #275 )
...
移除 OneinStack 相关文档，目前 OneinStack 已经完全无法使用。
https://oneinstack.com/
```release-note
None
```
2023-11-07 07:45:28 +00:00
Ryan Wang
6446098581
fix: broken links ( #266 )
...
修复所有文档的错误链接。
/kind documentation
```release-note
None
```
2023-10-23 08:51:29 +00:00
Ryan Wang
ba0c62ef6b
docs: update documentation for Halo 2.10 ( #262 )
...
为 Halo 2.10.0 更新文档。
/kind documentation
```release-note
None
```
2023-10-10 04:40:27 +00:00
Ryan Wang
12a8b47426
feat: add image zoom feature ( #250 )
...
支持点击放大图片。
```release-note
None
```
2023-09-06 08:56:14 +00:00
Ryan Wang
f1b641dc12
docs: update documentation for Halo 2.9 ( #246 )
...
为 Halo 2.9.0 更新文档。
/kind documentation
```release-note
None
```
2023-09-01 03:48:12 +00:00
Ryan Wang
11384757c9
chore: update umami tracker config ( #245 )
...
更新 Umami 统计的配置信息。
/kind improvement
```release-note
None
```
2023-08-21 11:38:11 +00:00
Ryan Wang
72c2ef8cc7
docs: update documentation for Halo 2.8 ( #238 )
...
为 Halo 2.8.0 更新文档。
/kind documentation
```release-note
None
```
2023-08-01 06:40:35 +00:00
Ryan Wang
18bab50498
docs: update documentation for Halo 2.7 ( #234 )
...
为 Halo 2.7.0 更新文档。
/kind documentation
```release-note
None
```
2023-06-30 05:08:11 +00:00
Ryan Wang
f9bbef1a63
chore: update site configs ( #227 )
...
1. 修改标题为 `Halo 文档`。
2. Sitemap 排除旧文档的索引，防止 Algolia 额度不够导致无法建索引。
3. 修改页面底部的 Copyright。
4. 修改底部的主题仓库为应用市场。
/kind improvement
```release-note
None
```
2023-06-07 09:57:22 +00:00
Ryan Wang
5d74edea8f
docs: update documentation for Halo 2.6 ( #222 )
...
为 Halo 2.6 更新文档。
/kind documentation
```release-note
None
```
2023-06-01 07:43:14 +00:00
Ryan Wang
bc5fe02283
docs: docs: update documentation for Halo 2.5 ( #212 )
...
为 Halo 2.5 更新文档。
/kind documentation
```release-note
None
```
2023-04-28 03:50:17 +00:00
Ryan Wang
4edbf7e639
docs: update documentation for Halo 2.4 ( #203 )
...
为 Halo 2.4 更新文档。
/kind documentation
```release-note
None
```
2023-03-31 03:54:14 +00:00
Ryan Wang
a23ea5940f
docs: update documentation for Halo 2.3 ( #196 )
...
为 Halo 2.3 更新文档。
/kind documentation
```release-note
None
```
2023-03-01 14:06:19 +00:00
Ryan Wang
55e5f60aee
docs: update documentation for Halo 2.2 ( #174 )
...
为 Halo 2.2 更新文档。
/kind documentation
```release-note
None
```
2023-02-01 04:14:09 +00:00
Ryan Wang
ef03b0fbfb
docs: update documentation for Halo 2.1 ( #162 )
...
为 Halo 2.1 更新文档。
see https://github.com/halo-dev/halo/releases/tag/v2.1.0
/kind documentation
```release-note
None
```
2023-01-03 07:56:36 +00:00
Ryan Wang
2ed9998d8a
docs: update documentation for Halo 2.0.1 ( #132 )
...
为 [Halo 2.0.1](https://github.com/halo-dev/halo/releases/tag/v2.0.1 ) 更新版本号。
/kind documentation
```release-note
None
```
2022-12-07 10:00:54 +00:00
Ryan Wang
5c76928800
chore: set 2.0 is latest version ( #127 )
...
将 2.0 版本的文档设置为最新的文档。同时保留 /2.0.0-SNAPSHOT/
/kind documentation
```release-note
None
```
2022-12-01 01:49:52 +00:00
Ryan Wang
aee974185e
docs: refine theme development documentation ( #110 )
...
完善 Halo 2.0 主题开发的文档。
/kind documentation
Fixes https://github.com/halo-dev/docs/issues/109
TODO list:
- [x] 准备工作 - 提供从搭建 Halo 开发环境到成功应用一个新的主题的过程。
- [x] 目录结构 - 详细解释一个主题的目录构成，包括每一个目录和文件的作用。
- [x] 配置文件 - 提供 `theme.yaml` 的各个配置的解释。
- [x] 设置选项 - 讲解如何在主题模板中使用主题定义的 `settings.yaml` 配置项。**注意：关于 settings.yaml 或许可以单独出一篇文档，因为插件也需要用到。主题和插件的文档只需要单独讲解如何使用**
- [x] 静态资源 - 讲解静态资源的引用。
- [x] 核心路由 - 列出 Halo 核心提供的路由以及模板，其中需要包括 `文章/自定义页面/分类的自定义模板` 的讲解
- [x] 模板变量 - 讲解系统内提供的路由对应模板中包含的变量。
- [x] Finder APIs - 讲解数据获取 API 的使用。
- [x] 常用代码片段 - 提供一些在主题开发中常用的代码片段，比如如何定义一个 `layout.html`，如何结构化渲染一个菜单或者文章分类等。
```release-note
None
```
2022-11-23 08:39:29 +00:00
Ryan Wang
4921736046
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
```
2022-10-13 03:58:14 +00:00
Ryan Wang
95971a90df
docs: documentation for Halo 2.0 ( #92 )
...
提供 Halo 2.0 的文档。
TODO list:
- [x] Halo 2.0 的配置文档
- [ ] ~~插件/主题开发的简要文档~~
```release-note
提供 Halo 2.0 的文档
```
2022-09-30 13:20:18 +00:00
Ryan Wang
2e421f26ab
chore: bump docusaurus to 2.1.0 ( #91 )
...
升级 docusaurus 到 2.1.0
- https://github.com/facebook/docusaurus/releases/tag/v2.0.0
- https://github.com/facebook/docusaurus/releases/tag/v2.1.0
```release-note
none
```
2022-09-28 15:14:16 +00:00
