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
Ryan Wang
f42f651081
chore: remove archived documentations ( #72 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc >
2022-04-14 07:49:17 +00:00
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 >
2022-04-14 05:35:16 +00:00
Ryan Wang
019aae4ad2
fix: google analytics settings ( #42 )
...
Signed-off-by: Ryan Wang <i@ryanc.cc >
2022-02-18 11:16:35 +08:00
Ryan Wang
a5c242093b
docs: remove sponsor doc ( #24 )
2022-01-07 20:52:24 +08:00
Ryan Wang
2986d23295
chore: update copyright to fit2cloud ( #22 )
2022-01-04 19:07:37 +08:00
Ryan Wang
65eee57a38
feat: support create versioning docs ( #16 )
2021-12-12 16:58:35 +08:00
Ryan Wang
de31762622
chore: remove wwads
2021-11-26 23:06:30 +08:00
Ryan Wang
7b07ac4711
docs: update docusaurus.config.js
2021-10-29 22:40:02 +08:00
Ryan Wang
03016cadbc
feat: add wwads plugin.
2021-10-12 19:05:00 +08:00
Ryan Wang
9b91f0e0d9
feat: update umami website id.
2021-10-10 00:42:47 +08:00
Ryan Wang
d0c8da473b
feat: add wwads.
2021-10-10 00:16:50 +08:00
Ryan Wang
a7151259cd
feat: add umami script.
2021-10-09 00:41:35 +08:00
Ryan Wang
c054998986
docs: update repo address.
2021-10-09 00:29:56 +08:00
Ryan Wang
60dc1880e6
feat: add route redirects.
2021-10-08 23:46:29 +08:00
Ryan Wang
20f9562836
chore: remove unnecessary images.
2021-10-08 23:22:52 +08:00
Ryan Wang
8ab25ab75f
feat: support search engine.
2021-10-08 23:12:34 +08:00
Ryan Wang
b43c1d3301
feat: add footer links
2021-10-08 20:02:24 +08:00
Ryan Wang
cb89a8b4ee
feat: add search bar.
2021-10-07 16:38:52 +08:00
Ryan Wang
47a0d35a0b
feat: update logo
2021-10-07 16:28:34 +08:00
Ryan Wang
4289778be3
feat: add images.
2021-10-05 15:21:21 +08:00
Ryan Wang
ff334efd4e
feat: add i18n
2021-10-05 14:50:31 +08:00
Ryan Wang
c76f2def87
refactor: disable blog.
2021-10-05 14:35:21 +08:00
Ryan Wang
d1d89b21a1
first commit
2021-10-05 14:30:42 +08:00
