Commit Graph

24 Commits

Author SHA1 Message Date
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
8759dafa82 docs: add documentation for user center (#290)
提供个人中心的文档。

/kind documentation

Fixes #285 

```release-note
None
```
2023-12-08 08:14:08 +00:00
Ryan Wang
a7707ee2ca docs: add documentation for setup page (#289)
添加系统初始化的文档。

/kind documentation

Fixes #286 

```release-note
None
```
2023-12-08 08:08:08 +00:00
Ryan Wang
b25183347f docs: add backup and restore documentations (#237)
添加备份和恢复的使用文档。

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/236

```release-note
None
```
2023-08-01 03:32:16 +00:00
Ryan Wang
2222905387 docs: improve documentation of 1Panel (#229)
优化使用 1Panel 部署的文档。

/kind documentation

```release-note
None
```
2023-06-12 06:50:11 +00:00
Ryan Wang
3ef8b4c0f9 docs: refactor documentations of user guide (#225)
重构用户指南的部分内容。

/kind documentation

```release-note
None
```
2023-06-09 03:02:11 +00:00
Ryan Wang
b3382b0170 docs: fix typos and word case (#226)
修正部分单词错误和写法错误。

/kind improvement

```release-note
None
```
2023-06-07 06:25:23 +00:00
BugKing
aaa258d244 docs: add docs for installation with 1Panel (#200)
增加使用 1Panel 进行部署的文档。

Fixes #199 

```release-note
None
```
2023-03-27 04:28:11 +00:00
guqing
f21171de21 feat: add plugin development docs (#123)
### What this PR does?
添加插件开发文档

### Which issue(s) this PR fixes
Fixes #113

/area docs

```release-note
None
```
2023-02-14 08:40:11 +00:00
Ryan Wang
1165cff265 docs: add documentation for annotations form definition (#165)
添加 Annotations Form 表单定义和使用的文档。

Fixes #154 

/kind documentation

```release-note
None
```
2023-01-05 09:10:37 +00:00
BugKing
f89f0beadf docs: refine user guide documentation for Halo 2.1.0 (#159)
为 Halo 2.1 完善用户使用指南。

/kind documentation

Fixes https://github.com/halo-dev/docs/issues/157

```release-note
None
```
2022-12-29 13:00:33 +00:00
RalstonLiu
1416be911c docs: add documentation for use with Nginx Proxy Manager (#149)
添加nginxproxymanager的文档,之前PR关闭了

```release-note
None
```
2022-12-26 02:50:32 +00:00
BugKing
2ec6fbb8af Fix illustration for uninstalling plugins (#152)
```release-note
fix: 卸载插件配图错误
````

Fixes #151
2022-12-22 07:32:29 +00:00
Simple-Stark
39d34fbea6 docs: improve the developer run guide (#139)
针对 WIndows 平台优化开发者运行的文档。

/kind documentation

```release-note
None
```
2022-12-12 04:04:22 +00:00
Ryan Wang
89fb87557c docs: update documentation for Halo 2.0.0 (#125)
为 Halo 2.0 正式版更新文档。

/kind documentation

```release-note
None
```
2022-12-01 01:33:51 +00:00
Ryan Wang
779e584dbd docs: adding documentation for migration from 1.x (#115)
添加从 1.x 迁移的文档。

See preview link at <https://halo-docs-git-fork-ruibaby-docs-add-docs-for-mi-9c13bf-halo-dev.vercel.app/2.0.0-SNAPSHOT/getting-started/migrate-from-1.x>.

```release-note
None
```
2022-12-01 01:31:58 +00:00
BugKing
daca55161a docs: add user guide and quick start (#124)
```release-note
docs: 补充快速入门及用户指南
```
2022-12-01 00:55:50 +00:00
Ryan Wang
74580f6b43 docs: tips for reload theme configs for theme development (#121)
/kind documentation

在主题开发文档中添加重载主题配置的提示。

```release-note
None
```
2022-11-28 10:06:17 +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
291023f4f9 docs: add documentation for local environment runs (#101)
添加本地开发环境运行的文档。

/kind documentation
/cc @halo-dev/sig-docs 

```release-note
None
```
2022-10-14 03:42:17 +00:00
Ryan Wang
20f9562836 chore: remove unnecessary images. 2021-10-08 23:22:52 +08:00
Ryan Wang
4289778be3 feat: add images. 2021-10-05 15:21:21 +08:00
Ryan Wang
d1d89b21a1 first commit 2021-10-05 14:30:42 +08:00