Commit Graph

134 Commits

Author SHA1 Message Date
Li
4fdea96f09 docs: add a tip for default admin username and password for development environment (#192)
添加开发环境下初始管理员用户名和密码的提示

/kind documentation

Fixes #188 

```release-note
None
```
2023-02-27 14:08:17 +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
e89334a6b4 docs: add documentation for custom template tag (#179)
添加 Halo 为 Thymeleaf 提供的 Halo 专有标签的文档。

/kind documentation

Fixes #160 

```release-note
None
```
2023-02-03 08:08:11 +00:00
Ryan Wang
6f8b67c9f0 docs: add documentation for template engine global variables (#180)
添加 Halo 为模板引擎提供的全局变量的文档。

/kind documentation

Fixes #161 

```release-note
None
```
2023-02-03 06:58:11 +00:00
Ryan Wang
d13c86a5a7 docs: add documentation for author template variables (#176)
添加主题端作者归档页面的文档。后端改动可查阅:https://github.com/halo-dev/docs/issues/144

/kind documentation

Fixes #143 

```release-note
None
```
2023-02-01 08:10:10 +00:00
Ryan Wang
922502a9d3 docs: add tips of console proxy (#178)
在开发环境文档中添加 Console 代理的提示。

/kind documentation

```release-note
None
```
2023-02-01 08:02:10 +00:00
Ryan Wang
d623ac063a docs: add lastModifyTime field description for post and singlePage related vo (#175)
为主题开发文档中关于文章和自定义页面的 VO 描述添加 lastModifyTime 字段。后端改动见:https://github.com/halo-dev/halo/pull/3101

/kind documentation

Fixes #169 

```release-note
None
```
2023-02-01 06:58:11 +00:00
Ryan Wang
8c3d6d097e fix: wrong example of contributor finder api (#166)
修复关于 Contributor 的 Finder API 示例错误的问题。

/kind documentation

Fixes #158 

```release-note
None
```
2023-01-05 15:40:37 +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
Ryan Wang
ec3cba41cf docs: add documentation about compilation (#138)
提供自编译可执行 JAR 和 Docker 镜像的文档。

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

/kind documentation

```release-note
None
```
2022-12-13 13:38:46 +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
36a4db6796 docs: refine the field descriptions of the theme VO (#133)
完善主题开发文档关于 VO 字段的描述。

/kind documentation

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

```release-note
None
```
2022-12-08 04:54:10 +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
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
b1ab9a37ef docs: tips for configuring template caching for theme development (#120)
/kind documentation

在主题开发文档中添加配置模板引擎缓存的提示。

```release-note
None
```
2022-11-28 01:36:17 +00:00
Ryan Wang
5295fc7748 docs: update documentation for Halo 2.0.0-rc.1 (#117)
为 Halo 2.0.0-rc.1 更新文档。

/kind documentation

```release-note
None
```
2022-11-24 15:53:06 +00:00
BugKing
51f76b1c58 docs: fix typo (#116)
```release-note
None
```
2022-11-24 10:21:05 +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
f92e5ca387 docs: add basic documentation for theme development (#102)
添加最基本的主题开发文档,仅编写从创建主题项目到最终预览的部分。

/kind documentation

```release-noe
None
```
2022-11-18 06:30:26 +00:00
Ryan Wang
d1cf855f2b docs: update documentation for Halo 2.0.0-beta.1 (#106)
/kind documentation

为 Halo 2.0.0-beta.1 修改版本号。

```release-note
None
```
2022-11-11 16:12:13 +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
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
Kent Liao
bf0e4ee4f0 fix: linkTag example (#86)
methods:
* listTeams
* listTeamsByRandom

```release-note
None
```
2022-08-02 14:14:19 +00:00
vayci
e855ddac26 fix: photoTag listByTeam example (#84)
Fixes #85 

```release-note
None
```
2022-08-01 12:36:11 +00:00
Ryan Wang
dcf872a0dc docs: fix cases (#66)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2022-03-31 16:34:06 +00:00
Ryan Wang
7e023448fc chore: use markdownlint and add pre commit hook (#41)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2022-02-14 15:34:33 +08:00
Lin
7b90df81c2 fix: typo in page-variable.md (#40) 2022-02-14 11:36:52 +08:00
Ryan Wang
7993abe690 docs: add the way to get the category tree in the theme development documentation (#37)
Signed-off-by: Ryan Wang <i@ryanc.cc>
2022-02-12 23:48:21 +08:00
John Niang
2005cb1819 Add step of choosing checkstyle version (#30) 2022-01-21 09:36:50 +08:00
guqing
847dce3ac4 refactor: the way of project clone (#8) 2021-12-08 14:07:28 +08:00
Ryan Wang
048ce27ce6 feat: add search bar. 2021-10-07 22:07:57 +08:00
Ryan Wang
722557cd47 refactor: remove unnecessary front matter. 2021-10-07 16:35:15 +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