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
```
4 months ago
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
```
4 months ago
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
```
5 months ago
Ryan Wang
7eec30763e
docs: update documentation for Halo 2.16 ( #367 )
...
为 Halo 2.16.0 更新文档。
/kind documentation
```release-note
None
```
6 months ago
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
```
6 months ago
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
```
6 months ago
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
```
6 months ago
Ryan Wang
b4e637b4b0
chore: use selfhosted-meilisearch as docs search engine ( #357 )
...
使用自建的 Meilisearch 作为文档搜索引擎,代替 Algolia。
/kind improvement
```release-note
None
```
6 months ago
Ryan Wang
846d6c3791
docs: update documentation for Halo 2.15 ( #345 )
...
为 Halo 2.15.0 更新文档。
/kind documentation
```release-note
None
```
7 months ago
Ryan Wang
6e97f3724b
docs: update documentation for Halo 2.14 ( #334 )
...
为 Halo 2.14.0 更新文档。
/kind documentation
```release-note
None
```
8 months ago
Ryan Wang
7dd663136d
docs: update documentation for Halo 2.13 ( #321 )
...
为 Halo 2.13.0 更新文档。
/kind documentation
```release-note
None
```
9 months ago
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
```
10 months ago
Ryan Wang
d0ea59e6e2
docs: update documentation for Halo 2.12 ( #306 )
...
为 Halo 2.12.0 更新文档。
/kind documentation
```release-note
None
```
10 months ago
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>
10 months ago
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
```
11 months ago
Ryan Wang
7e8a8ecb0d
docs: update documentation for Halo 2.11 ( #283 )
...
为 Halo 2.11.0 更新文档。
/kind documentation
```release-note
None
```
12 months ago
Ryan Wang
d80d49e1ac
docs: remove oneinstack related documentations ( #275 )
...
移除 OneinStack 相关文档,目前 OneinStack 已经完全无法使用。
https://oneinstack.com/
```release-note
None
```
1 year ago
Ryan Wang
6446098581
fix: broken links ( #266 )
...
修复所有文档的错误链接。
/kind documentation
```release-note
None
```
1 year ago
Ryan Wang
ba0c62ef6b
docs: update documentation for Halo 2.10 ( #262 )
...
为 Halo 2.10.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
Ryan Wang
12a8b47426
feat: add image zoom feature ( #250 )
...
支持点击放大图片。
```release-note
None
```
1 year ago
Ryan Wang
f1b641dc12
docs: update documentation for Halo 2.9 ( #246 )
...
为 Halo 2.9.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
Ryan Wang
11384757c9
chore: update umami tracker config ( #245 )
...
更新 Umami 统计的配置信息。
/kind improvement
```release-note
None
```
1 year ago
Ryan Wang
72c2ef8cc7
docs: update documentation for Halo 2.8 ( #238 )
...
为 Halo 2.8.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
Ryan Wang
18bab50498
docs: update documentation for Halo 2.7 ( #234 )
...
为 Halo 2.7.0 更新文档。
/kind documentation
```release-note
None
```
1 year ago
Ryan Wang
f9bbef1a63
chore: update site configs ( #227 )
...
1. 修改标题为 `Halo 文档`。
2. Sitemap 排除旧文档的索引,防止 Algolia 额度不够导致无法建索引。
3. 修改页面底部的 Copyright。
4. 修改底部的主题仓库为应用市场。
/kind improvement
```release-note
None
```
1 year ago
Ryan Wang
5d74edea8f
docs: update documentation for Halo 2.6 ( #222 )
...
为 Halo 2.6 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
bc5fe02283
docs: docs: update documentation for Halo 2.5 ( #212 )
...
为 Halo 2.5 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
4edbf7e639
docs: update documentation for Halo 2.4 ( #203 )
...
为 Halo 2.4 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
a23ea5940f
docs: update documentation for Halo 2.3 ( #196 )
...
为 Halo 2.3 更新文档。
/kind documentation
```release-note
None
```
2 years ago
Ryan Wang
55e5f60aee
docs: update documentation for Halo 2.2 ( #174 )
...
为 Halo 2.2 更新文档。
/kind documentation
```release-note
None
```
2 years ago
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
```
2 years ago
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
```
2 years ago
Ryan Wang
5c76928800
chore: set 2.0 is latest version ( #127 )
...
将 2.0 版本的文档设置为最新的文档。同时保留 /2.0.0-SNAPSHOT/
/kind documentation
```release-note
None
```
2 years ago
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
```
2 years ago
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
```
2 years ago
Ryan Wang
95971a90df
docs: documentation for Halo 2.0 ( #92 )
...
提供 Halo 2.0 的文档。
TODO list:
- [x] Halo 2.0 的配置文档
- [ ] ~~插件/主题开发的简要文档~~
```release-note
提供 Halo 2.0 的文档
```
2 years ago
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
```
2 years ago
Ryan Wang
f42f651081
chore: remove archived documentations ( #72 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
Ryan Wang
d605271fcc
docs: update markdown.md for Halo 1.5.x ( #70 )
...
* doc: update markdown document
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: update markdown.md
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: update markdown.md
Signed-off-by: Ryan Wang <i@ryanc.cc>
* docs: update markdown.md
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
Ryan Wang
019aae4ad2
fix: google analytics settings ( #42 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc>
3 years ago
Ryan Wang
a5c242093b
docs: remove sponsor doc ( #24 )
3 years ago
Ryan Wang
2986d23295
chore: update copyright to fit2cloud ( #22 )
3 years ago
Ryan Wang
65eee57a38
feat: support create versioning docs ( #16 )
3 years ago
Ryan Wang
de31762622
chore: remove wwads
3 years ago
Ryan Wang
7b07ac4711
docs: update docusaurus.config.js
3 years ago
Ryan Wang
03016cadbc
feat: add wwads plugin.
3 years ago
Ryan Wang
9b91f0e0d9
feat: update umami website id.
3 years ago
Ryan Wang
d0c8da473b
feat: add wwads.
3 years ago
Ryan Wang
a7151259cd
feat: add umami script.
3 years ago
Ryan Wang
c054998986
docs: update repo address.
3 years ago