Skip to content

Commit 2ee5f3f

Browse files
authored
Merge pull request #623 from intoyang/docs/add-online-demo-page
Reorganize the user guide and improve documentation navigation
2 parents 0ef80ff + 18421e1 commit 2ee5f3f

33 files changed

Lines changed: 499 additions & 51 deletions

docs/developer-guide/_meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{
33
"type": "file",
44
"name": "index",
5-
"label": "概览"
5+
"label": "内容导航"
66
},
77
{
88
"type": "dir",

docs/guide/_meta.json

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@
22
{
33
"type": "file",
44
"name": "index",
5-
"label": "概览"
5+
"label": "内容导航"
66
},
77
{
88
"type": "section-header",
99
"label": "入门"
1010
},
1111
"prepare",
12+
"demo",
1213
{
1314
"type": "dir",
1415
"name": "install",
15-
"label": "安装",
16+
"label": "快速安装",
1617
"collapsed": true
1718
},
1819
{
@@ -24,9 +25,16 @@
2425
{
2526
"type": "dir",
2627
"name": "use",
27-
"label": "功能文档",
28+
"label": "常用模块",
2829
"collapsed": true
2930
},
31+
{
32+
"type": "dir",
33+
"name": "shop",
34+
"label": "商城模块",
35+
"collapsed": true
36+
},
37+
"faq",
3038
{
3139
"type": "dir-section-header",
3240
"name": "contribution",

docs/guide/demo.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: 在线体验
3+
description: 通过 Halo 演示环境体验站点前台和管理后台。
4+
---
5+
6+
无需安装或部署,即可访问以下演示环境体验 Halo:
7+
8+
- 站点地址:<https://demo.halocms.site>
9+
- 管理后台:<https://demo.halocms.site/console>
10+
- 用户名:`demo`
11+
- 密码:`P@ssw0rd123..`
12+
13+
:::warning 注意
14+
演示环境仅供功能体验,请勿上传或填写敏感信息。
15+
:::
16+
17+
如需在本地搭建体验环境,请参考[《如何在本地快速体验 Halo》](https://www.halo.run/archives/halo-local-quickstart)
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ description: Halo 使用常见问题:产品定位、数据库结构、找回
1515
### 忘记密码怎么办?
1616

1717
1. 站点管理员已经配置好邮件通知,并且用户已完成电子邮箱验证时,可以点击登录页面的 `找回密码` 链接,填写邮箱后,系统将向该邮箱发送密码重置链接,用户可通过该链接重置密码;
18-
2. 如果不满足上述条件,或者密码重置邮件不能发送成功,请直接联系具有用户管理权限的管理员进行密码重置操作,管理员可参考文档[修改用户密码](./users#修改用户密码)部分修改指定用户的密码;
18+
2. 如果不满足上述条件,或者密码重置邮件不能发送成功,请直接联系具有用户管理权限的管理员进行密码重置操作,管理员可参考文档[修改用户密码](./use/users#修改用户密码)部分修改指定用户的密码;
1919
3. 如果系统没有任何一个能够正常登录控制台且具有用户管理权限的管理员账号,则用户需要通过更新数据库记录的方式重置指定用户的密码。
2020

2121
:::info 参考 SQL 语句
@@ -109,7 +109,7 @@ docker run \
109109
registry.fit2cloud.com/halo/halo-pro:2.26 \
110110
```
111111

112-
更多 Docker 相关的教程请参考:[使用 Docker 部署 Halo](../install/docker.mdx)
112+
更多 Docker 相关的教程请参考:[使用 Docker 部署 Halo](./install/docker.mdx)
113113

114114
### 如何查看运行日志?
115115

@@ -127,7 +127,7 @@ docker run \
127127

128128
前台样式不正常或者丢失有很多种问题的可能,最快捷定位问题的方式就是打开浏览器控制台查看具体请求的错误,以下列出了部分导致出现该问题的常见原因:
129129

130-
1. `外部访问地址` 与实际访问地址不一致。也可能是开启了 https 之后,无法正常加载 http 资源,将 [外部访问地址](../install/config.md#halo-独有配置) 改为 https 协议即可。
130+
1. `外部访问地址` 与实际访问地址不一致。也可能是开启了 https 之后,无法正常加载 http 资源,将 [外部访问地址](./install/config.md#halo-独有配置) 改为 https 协议即可。
131131
2. Nginx 配置了静态资源缓存,但没有设置 `proxy_pass`,参考如下:
132132

133133
```nginx

docs/guide/prepare.md

Lines changed: 69 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,70 @@
11
---
22
title: 写在前面
3-
description: Halo 部署前必读:社区版与付费版、软硬件环境、域名与 HTTPS 等准备事项
3+
description: 了解 Halo、发行版本、应用生态,以及部署前所需的软硬件环境
44
---
55

6+
<div class="rp-project-header">
7+
<p align="center">
8+
<a href="https://www.halo.run" target="_blank" rel="noopener noreferrer"><img width="100" src="https://www.halo.run/logo" alt="Halo logo" class="no-zoom" /></a>
9+
</p>
10+
11+
<p align="center"><b>Halo</b> [ˈheɪloʊ],强大易用的开源建站工具。</p>
12+
13+
<p align="center" class="rp-project-header__badges">
14+
<a href="https://github.com/halo-dev/halo/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/halo-dev/halo.svg?style=flat-square&include_prereleases" class="no-zoom" /></a>
15+
<a href="https://hub.docker.com/r/halohub/halo"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/halohub/halo?style=flat-square" class="no-zoom" /></a>
16+
<a href="https://github.com/halo-dev/halo/commits"><img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/halo-dev/halo.svg?style=flat-square" class="no-zoom" /></a>
17+
<a href="https://github.com/halo-dev/halo/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/halo-dev/halo/halo.yaml?branch=main&style=flat-square" class="no-zoom" /></a>
18+
<a href="https://codecov.io/gh/halo-dev/halo"><img alt="Codecov percentage" src="https://img.shields.io/codecov/c/github/halo-dev/halo/main?style=flat-square&token=YsRUg9fall" class="no-zoom" /></a>
19+
</p>
20+
</div>
21+
22+
## Halo 是什么?
23+
24+
Halo 是一款强大易用的开源建站工具,从个人博客、知识库,到企业官网、在线商城,Halo 都能助您轻松实现,一站式满足您的多样化建站需求。
25+
26+
<a href="https://www.bilibili.com/video/BV15x4y1U7RU" target="_blank" rel="noopener noreferrer" class="rp-image-link" aria-label="播放 Halo 介绍视频" title="播放 Halo 介绍视频"><img src="https://www.halo.run/upload/dashboard-2026-03-26-5.png" alt="Halo 管理后台界面" class="no-zoom" /><span class="rp-image-link__play" aria-hidden="true"><svg viewBox="0 0 24 24" focusable="false"><path fill="currentColor" d="M5.669 4.76a1.47 1.47 0 0 1 2.04-1.177c1.062.453 3.442 1.532 6.462 3.276c3.021 1.744 5.146 3.266 6.069 3.958c.788.59.79 1.763.001 2.355c-.914.687-3.013 2.191-6.07 3.956c-3.06 1.766-5.412 2.832-6.464 3.28a1.467 1.467 0 0 1-2.038-1.177c-.138-1.141-.396-3.734-.396-7.236c0-3.5.257-6.092.396-7.235" /></svg></span></a>
27+
628
## 发行版本
729

8-
Halo 的发行版本主要区分为两个大类别,即 **Halo 社区版****Halo 付费版**
30+
Halo 的发行版本主要分为两个大类别,即**Halo 社区版****Halo 付费版**
31+
32+
Halo 付费版包含专业版和商城版,是[**凌霞软件**](https://www.lxware.cn/)旗下的商业产品,致力于为企业、团体或有进阶需求的个人用户提供定制化和特定场景的功能支持。
33+
34+
关于三个版本的详细区别,请查阅[**版本对比**](https://www.lxware.cn/halo)
35+
36+
在后续的文档中,除非特别说明,将使用付费版统称 Halo 专业版和 Halo 商城版。
37+
38+
### Halo 社区版
39+
40+
Halo 社区版开源免费,遵循 GPL-3.0 协议,适合个人开发者、技术爱好者和开源项目。
941

10-
Halo 付费版包括专业版和商城版,是[凌霞软件](https://www.lxware.cn?code=mcYhwMkn)旗下的商业产品,为企业/团体/或进阶个人使用者提供了诸多定制化和特定场景的功能支持。
42+
- 零成本搭建博客、作品集、技术文档站
43+
- 提供超过 100 款免费主题和插件
1144

12-
版本区别可查阅 [方案对比](https://www.lxware.cn/halo?code=mcYhwMkn)
45+
### Halo 专业版
1346

14-
在后续的文档中,使用付费版统称 Halo 专业版 和 Halo 商城版,除非特别说明。
47+
Halo 专业版在社区版基础上,集成多项适用于专业场景的功能:
1548

16-
## 在线体验
49+
- 移动端 App:随时随地管理内容
50+
- AI 智能建站:快速生成专业站点
51+
- 手机号验证登录:提升安全性与用户体验
52+
- 全站私有化部署:保障数据主权
53+
- 付费主题与插件市场:提供精品主题,以及 SEO 优化、付费阅读、AI 助手等付费插件
1754

18-
- 环境地址:<https://demo.halocms.site>
19-
- 后台地址:<https://demo.halocms.site/console>
20-
- 用户名:`demo`
21-
- 密码:`P@ssw0rd123..`
55+
### Halo 商城版
2256

23-
或者也可以参考 [《如何在本地快速体验 Halo》](https://www.halo.run/archives/halo-local-quickstart) 在本地搭建体验环境。
57+
Halo 商城版在专业版基础上,提供在线商城功能:
58+
59+
- 一体化在线商城:覆盖商品管理、订单处理和支付对接流程
60+
- 面向中国商家:集成微信支付、支付宝等本土支付方式
61+
- 支持品牌官网、内容管理和线上店铺一站式建设
62+
63+
## 应用生态
64+
65+
- **应用市场**:提供丰富的站点主题与功能插件,前往 [Halo 应用市场](https://www.halo.run/store/apps)了解详情。
66+
- **成为开发者**:支持自主发布并管理应用,参阅[应用市场开发者入驻及应用创建指南](https://www.halo.run/archives/halo-app-store-developer-onboarding-app-creation)
67+
- **社区资源**:访问 [Awesome Halo](https://github.com/halo-sigs/awesome-halo),了解 Halo 相关的精选资源。
2468

2569
## 环境要求
2670

@@ -143,3 +187,17 @@ Halo 目前支持以下数据库:
143187
用于扩展 Halo 功能的软件包。插件独立于 Halo 核心应用,可以单独安装、升级、卸载。
144188

145189
相关使用文档:[插件管理相关功能说明](../guide/use/plugins.md)
190+
191+
## 许可证
192+
193+
Halo 使用 [GPL-3.0](https://github.com/halo-dev/halo/blob/main/LICENSE) 协议开源,使用和分发时请遵守开源协议。
194+
195+
## 贡献者
196+
197+
欢迎参与 Halo 项目建设,具体方式请参阅 [Halo 贡献指南](https://github.com/halo-dev/halo/blob/main/CONTRIBUTING.md)
198+
199+
<a href="https://github.com/halo-dev/halo/graphs/contributors"><img src="https://opencollective.com/halo/contributors.svg?width=890&button=false" alt="Halo 项目贡献者" /></a>
200+
201+
## 项目状态
202+
203+
![Halo 项目活跃度](https://repobeats.axiom.co/api/embed/ad008b2151c22e7cf734d2688befaa795d593b95.svg "Halo 项目活跃度")
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Halo 商城顾客在个人中心管理收货地址、优惠券和
44
---
55

66
:::note 仅限 Halo 商城版
7-
[Halo 商城版](../../prepare.md#发行版本) 可用。
7+
[Halo 商城版](../prepare.md#发行版本) 可用。
88
:::
99

1010
顾客登录后,可以访问 `/uc`,从个人中心管理自己的收货地址、优惠券和订单。
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: 商城
2+
title: 商城模块
33
description: Halo 商城版功能概览:开店、商品、支付发货与前台路由等用户指南索引。
44
overview: true
55
---
66

77
import { Tab, Tabs } from "@rspress/core/theme";
88

99
:::note 仅限 Halo 商城版
10-
[Halo 商城版](../../prepare.md#发行版本) 可用。
10+
[Halo 商城版](../prepare.md#发行版本) 可用。
1111
:::
1212

1313
商城模块是 Halo 商城版的一项功能,支持用户基于 Halo 站点创建店铺,上架多种类型的货品,配置商品支付和发货方式。为实体商品、虚拟商品、链接商品等销售场景提供完备的电商解决方案。
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 使用 Halo 商城的折扣和优惠券功能设置活动规则、
44
---
55

66
:::note 仅限 Halo 商城版
7-
[Halo 商城版](../../prepare.md#发行版本) 可用。
7+
[Halo 商城版](../prepare.md#发行版本) 可用。
88
:::
99

1010
登录 Halo 控制台,进入 **商店 -> 营销**。商城提供 **折扣****优惠券** 两类营销工具。

0 commit comments

Comments
 (0)