diff --git a/docs/developer-guide/_meta.json b/docs/developer-guide/_meta.json index c3ae4d83..f72e04ef 100644 --- a/docs/developer-guide/_meta.json +++ b/docs/developer-guide/_meta.json @@ -2,7 +2,7 @@ { "type": "file", "name": "index", - "label": "概览" + "label": "内容导航" }, { "type": "dir", diff --git a/docs/guide/_meta.json b/docs/guide/_meta.json index 6b42367a..7d49f8a6 100644 --- a/docs/guide/_meta.json +++ b/docs/guide/_meta.json @@ -2,17 +2,18 @@ { "type": "file", "name": "index", - "label": "概览" + "label": "内容导航" }, { "type": "section-header", "label": "入门" }, "prepare", + "demo", { "type": "dir", "name": "install", - "label": "安装", + "label": "快速安装", "collapsed": true }, { @@ -24,9 +25,16 @@ { "type": "dir", "name": "use", - "label": "功能文档", + "label": "常用模块", "collapsed": true }, + { + "type": "dir", + "name": "shop", + "label": "商城模块", + "collapsed": true + }, + "faq", { "type": "dir-section-header", "name": "contribution", diff --git a/docs/guide/demo.md b/docs/guide/demo.md new file mode 100644 index 00000000..0c6abb8f --- /dev/null +++ b/docs/guide/demo.md @@ -0,0 +1,17 @@ +--- +title: 在线体验 +description: 通过 Halo 演示环境体验站点前台和管理后台。 +--- + +无需安装或部署，即可访问以下演示环境体验 Halo： + +- 站点地址： +- 管理后台： +- 用户名：`demo` +- 密码：`P@ssw0rd123..` + +:::warning 注意 +演示环境仅供功能体验，请勿上传或填写敏感信息。 +::: + +如需在本地搭建体验环境，请参考[《如何在本地快速体验 Halo》](https://www.halo.run/archives/halo-local-quickstart)。 diff --git a/docs/guide/use/faq.md b/docs/guide/faq.md similarity index 96% rename from docs/guide/use/faq.md rename to docs/guide/faq.md index 73c9fbba..67b350b0 100644 --- a/docs/guide/use/faq.md +++ b/docs/guide/faq.md @@ -15,7 +15,7 @@ description: Halo 使用常见问题：产品定位、数据库结构、找回 ### 忘记密码怎么办？ 1. 站点管理员已经配置好邮件通知，并且用户已完成电子邮箱验证时，可以点击登录页面的 `找回密码` 链接，填写邮箱后，系统将向该邮箱发送密码重置链接，用户可通过该链接重置密码； -2. 如果不满足上述条件，或者密码重置邮件不能发送成功，请直接联系具有用户管理权限的管理员进行密码重置操作，管理员可参考文档[修改用户密码](./users#修改用户密码)部分修改指定用户的密码； +2. 如果不满足上述条件，或者密码重置邮件不能发送成功，请直接联系具有用户管理权限的管理员进行密码重置操作，管理员可参考文档[修改用户密码](./use/users#修改用户密码)部分修改指定用户的密码； 3. 如果系统没有任何一个能够正常登录控制台且具有用户管理权限的管理员账号，则用户需要通过更新数据库记录的方式重置指定用户的密码。 :::info 参考 SQL 语句 @@ -109,7 +109,7 @@ docker run \ registry.fit2cloud.com/halo/halo-pro:2.26 \ ``` -更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](../install/docker.mdx) +更多 Docker 相关的教程请参考：[使用 Docker 部署 Halo](./install/docker.mdx) ### 如何查看运行日志？ @@ -127,7 +127,7 @@ docker run \ 前台样式不正常或者丢失有很多种问题的可能，最快捷定位问题的方式就是打开浏览器控制台查看具体请求的错误，以下列出了部分导致出现该问题的常见原因： -1. `外部访问地址` 与实际访问地址不一致。也可能是开启了 https 之后，无法正常加载 http 资源，将 [外部访问地址](../install/config.md#halo-独有配置) 改为 https 协议即可。 +1. `外部访问地址` 与实际访问地址不一致。也可能是开启了 https 之后，无法正常加载 http 资源，将 [外部访问地址](./install/config.md#halo-独有配置) 改为 https 协议即可。 2. Nginx 配置了静态资源缓存，但没有设置 `proxy_pass`，参考如下： ```nginx diff --git a/docs/guide/prepare.md b/docs/guide/prepare.md index a64f0f3e..5ebaaf5e 100644 --- a/docs/guide/prepare.md +++ b/docs/guide/prepare.md @@ -1,26 +1,70 @@ --- title: 写在前面 -description: Halo 部署前必读：社区版与付费版、软硬件环境、域名与 HTTPS 等准备事项。 +description: 了解 Halo、发行版本、应用生态，以及部署前所需的软硬件环境。 --- +
+

+ Halo logo +

+ +

Halo [ˈheɪloʊ]，强大易用的开源建站工具。

+ +

+ GitHub release + Docker pulls + GitHub last commit + GitHub Workflow Status + Codecov percentage +

+
+ +## Halo 是什么？ + +Halo 是一款强大易用的开源建站工具，从个人博客、知识库，到企业官网、在线商城，Halo 都能助您轻松实现，一站式满足您的多样化建站需求。 + +Halo 管理后台界面 + ## 发行版本 -Halo 的发行版本主要区分为两个大类别，即 **Halo 社区版** 和 **Halo 付费版**。 +Halo 的发行版本主要分为两个大类别，即**Halo 社区版**和 **Halo 付费版**。 + +Halo 付费版包含专业版和商城版，是[**凌霞软件**](https://www.lxware.cn/)旗下的商业产品，致力于为企业、团体或有进阶需求的个人用户提供定制化和特定场景的功能支持。 + +关于三个版本的详细区别，请查阅[**版本对比**](https://www.lxware.cn/halo)。 + +在后续的文档中，除非特别说明，将使用付费版统称 Halo 专业版和 Halo 商城版。 + +### Halo 社区版 + +Halo 社区版开源免费，遵循 GPL-3.0 协议，适合个人开发者、技术爱好者和开源项目。 -Halo 付费版包括专业版和商城版，是[凌霞软件](https://www.lxware.cn?code=mcYhwMkn)旗下的商业产品，为企业/团体/或进阶个人使用者提供了诸多定制化和特定场景的功能支持。 +- 零成本搭建博客、作品集、技术文档站 +- 提供超过 100 款免费主题和插件 -版本区别可查阅 [方案对比](https://www.lxware.cn/halo?code=mcYhwMkn) +### Halo 专业版 -在后续的文档中，使用付费版统称 Halo 专业版 和 Halo 商城版，除非特别说明。 +Halo 专业版在社区版基础上，集成多项适用于专业场景的功能： -## 在线体验 +- 移动端 App：随时随地管理内容 +- AI 智能建站：快速生成专业站点 +- 手机号验证登录：提升安全性与用户体验 +- 全站私有化部署：保障数据主权 +- 付费主题与插件市场：提供精品主题，以及 SEO 优化、付费阅读、AI 助手等付费插件 -- 环境地址： -- 后台地址： -- 用户名：`demo` -- 密码：`P@ssw0rd123..` +### Halo 商城版 -或者也可以参考 [《如何在本地快速体验 Halo》](https://www.halo.run/archives/halo-local-quickstart) 在本地搭建体验环境。 +Halo 商城版在专业版基础上，提供在线商城功能： + +- 一体化在线商城：覆盖商品管理、订单处理和支付对接流程 +- 面向中国商家：集成微信支付、支付宝等本土支付方式 +- 支持品牌官网、内容管理和线上店铺一站式建设 + +## 应用生态 + +- **应用市场**：提供丰富的站点主题与功能插件，前往 [Halo 应用市场](https://www.halo.run/store/apps)了解详情。 +- **成为开发者**：支持自主发布并管理应用，参阅[应用市场开发者入驻及应用创建指南](https://www.halo.run/archives/halo-app-store-developer-onboarding-app-creation)。 +- **社区资源**：访问 [Awesome Halo](https://github.com/halo-sigs/awesome-halo)，了解 Halo 相关的精选资源。 ## 环境要求 @@ -143,3 +187,17 @@ Halo 目前支持以下数据库： 用于扩展 Halo 功能的软件包。插件独立于 Halo 核心应用，可以单独安装、升级、卸载。 相关使用文档：[插件管理相关功能说明](../guide/use/plugins.md) + +## 许可证 + +Halo 使用 [GPL-3.0](https://github.com/halo-dev/halo/blob/main/LICENSE) 协议开源，使用和分发时请遵守开源协议。 + +## 贡献者 + +欢迎参与 Halo 项目建设，具体方式请参阅 [Halo 贡献指南](https://github.com/halo-dev/halo/blob/main/CONTRIBUTING.md)。 + +Halo 项目贡献者 + +## 项目状态 + +![Halo 项目活跃度](https://repobeats.axiom.co/api/embed/ad008b2151c22e7cf734d2688befaa795d593b95.svg "Halo 项目活跃度") diff --git a/docs/guide/use/shop/_meta.json b/docs/guide/shop/_meta.json similarity index 100% rename from docs/guide/use/shop/_meta.json rename to docs/guide/shop/_meta.json diff --git a/docs/guide/use/shop/console-home.mdx b/docs/guide/shop/console-home.mdx similarity index 100% rename from docs/guide/use/shop/console-home.mdx rename to docs/guide/shop/console-home.mdx diff --git a/docs/guide/use/shop/customer-center.md b/docs/guide/shop/customer-center.md similarity index 96% rename from docs/guide/use/shop/customer-center.md rename to docs/guide/shop/customer-center.md index be0c418d..1a8d9b65 100644 --- a/docs/guide/use/shop/customer-center.md +++ b/docs/guide/shop/customer-center.md @@ -4,7 +4,7 @@ description: Halo 商城顾客在个人中心管理收货地址、优惠券和 --- :::note 仅限 Halo 商城版 -限 [Halo 商城版](../../prepare.md#发行版本) 可用。 +限 [Halo 商城版](../prepare.md#发行版本) 可用。 ::: 顾客登录后，可以访问 `/uc`，从个人中心管理自己的收货地址、优惠券和订单。 diff --git a/docs/guide/use/shop/index.mdx b/docs/guide/shop/index.mdx similarity index 93% rename from docs/guide/use/shop/index.mdx rename to docs/guide/shop/index.mdx index 3b4e5878..5354f1fb 100644 --- a/docs/guide/use/shop/index.mdx +++ b/docs/guide/shop/index.mdx @@ -1,5 +1,5 @@ --- -title: 商城 +title: 商城模块 description: Halo 商城版功能概览：开店、商品、支付发货与前台路由等用户指南索引。 overview: true --- @@ -7,7 +7,7 @@ overview: true import { Tab, Tabs } from "@rspress/core/theme"; :::note 仅限 Halo 商城版 -限 [Halo 商城版](../../prepare.md#发行版本) 可用。 +限 [Halo 商城版](../prepare.md#发行版本) 可用。 ::: 商城模块是 Halo 商城版的一项功能，支持用户基于 Halo 站点创建店铺，上架多种类型的货品，配置商品支付和发货方式。为实体商品、虚拟商品、链接商品等销售场景提供完备的电商解决方案。 diff --git a/docs/guide/use/shop/marketing.md b/docs/guide/shop/marketing.md similarity index 96% rename from docs/guide/use/shop/marketing.md rename to docs/guide/shop/marketing.md index 44617156..81ced088 100644 --- a/docs/guide/use/shop/marketing.md +++ b/docs/guide/shop/marketing.md @@ -4,7 +4,7 @@ description: 使用 Halo 商城的折扣和优惠券功能设置活动规则、 --- :::note 仅限 Halo 商城版 -限 [Halo 商城版](../../prepare.md#发行版本) 可用。 +限 [Halo 商城版](../prepare.md#发行版本) 可用。 ::: 登录 Halo 控制台，进入 **商店 -> 营销**。商城提供 **折扣** 和 **优惠券** 两类营销工具。 diff --git a/docs/guide/use/shop/mp.mdx b/docs/guide/shop/mp.mdx similarity index 100% rename from docs/guide/use/shop/mp.mdx rename to docs/guide/shop/mp.mdx diff --git a/docs/guide/use/shop/orders.mdx b/docs/guide/shop/orders.mdx similarity index 100% rename from docs/guide/use/shop/orders.mdx rename to docs/guide/shop/orders.mdx diff --git a/docs/guide/use/shop/payments.mdx b/docs/guide/shop/payments.mdx similarity index 100% rename from docs/guide/use/shop/payments.mdx rename to docs/guide/shop/payments.mdx diff --git a/docs/guide/use/shop/prepare.mdx b/docs/guide/shop/prepare.mdx similarity index 89% rename from docs/guide/use/shop/prepare.mdx rename to docs/guide/shop/prepare.mdx index 9403677c..f69e1fed 100644 --- a/docs/guide/use/shop/prepare.mdx +++ b/docs/guide/shop/prepare.mdx @@ -7,8 +7,8 @@ description: 启用 Halo 商城前：商城版安装激活、合规资质与支 在开始使用商城功能之前，需要先确定以下条件是否已满足： -- 正常安装 [Halo 商城版](../../install/index.md) -- 激活 [Halo 商城版许可证](../activate.md) +- 正常安装 [Halo 商城版](../install/index.md) +- 激活 [Halo 商城版许可证](../use/activate.md) - 根据当地法律法规，满足开设网络商店的资质与要求 - 开通支付平台账户，目前支持： - [支付宝官方接口](https://open.alipay.com/) @@ -29,4 +29,4 @@ description: 启用 Halo 商城前：商城版安装激活、合规资质与支 这些页面无需主题提供对应的模板文件即可访问，使用的是系统内置的模板文件。如果当前激活的主题提供了对应的模板文件，则会优先使用主题提供的模板文件。 ::: -你可以根据需求，将这些页面路径添加到[网站菜单](../menus.md)中。 +你可以根据需求，将这些页面路径添加到[网站菜单](../use/menus.md)中。 diff --git a/docs/guide/use/shop/products.mdx b/docs/guide/shop/products.mdx similarity index 100% rename from docs/guide/use/shop/products.mdx rename to docs/guide/shop/products.mdx diff --git a/docs/guide/use/shop/sales-channels.mdx b/docs/guide/shop/sales-channels.mdx similarity index 100% rename from docs/guide/use/shop/sales-channels.mdx rename to docs/guide/shop/sales-channels.mdx diff --git a/docs/guide/use/shop/settings.md b/docs/guide/shop/settings.md similarity index 96% rename from docs/guide/use/shop/settings.md rename to docs/guide/shop/settings.md index d30fe193..b39f4322 100644 --- a/docs/guide/use/shop/settings.md +++ b/docs/guide/shop/settings.md @@ -4,7 +4,7 @@ description: 配置 Halo 商城的联系方式、询价跳转、小程序首页 --- :::note 仅限 Halo 商城版 -限 [Halo 商城版](../../prepare.md#发行版本) 可用。 +限 [Halo 商城版](../prepare.md#发行版本) 可用。 ::: 登录 Halo 控制台，进入 **商店 -> 设置**。支付方式和销售渠道分别参见[支付方式](./payments.mdx)与[销售渠道](./sales-channels.mdx)，本页介绍其余设置。 diff --git a/docs/guide/use/shop/theme-dev.mdx b/docs/guide/shop/theme-dev.mdx similarity index 100% rename from docs/guide/use/shop/theme-dev.mdx rename to docs/guide/shop/theme-dev.mdx diff --git a/docs/guide/use/shop/virtual-delivery.mdx b/docs/guide/shop/virtual-delivery.mdx similarity index 100% rename from docs/guide/use/shop/virtual-delivery.mdx rename to docs/guide/shop/virtual-delivery.mdx diff --git a/docs/guide/use/shop/webhooks.md b/docs/guide/shop/webhooks.md similarity index 100% rename from docs/guide/use/shop/webhooks.md rename to docs/guide/shop/webhooks.md diff --git a/docs/guide/use/_meta.json b/docs/guide/use/_meta.json index 25f2b7e5..d7ea955a 100644 --- a/docs/guide/use/_meta.json +++ b/docs/guide/use/_meta.json @@ -14,12 +14,5 @@ "users", "settings", "backup", - "mobile-app", - { - "type": "dir", - "name": "shop", - "label": "商城", - "collapsed": true - }, - "faq" + "mobile-app" ] diff --git a/docs/guide/use/common.md b/docs/guide/use/common.md index 7202543d..8b432a57 100644 --- a/docs/guide/use/common.md +++ b/docs/guide/use/common.md @@ -1,5 +1,5 @@ --- -title: 基础说明 +title: 概念说明 description: Halo 建站入门：登录注册、控制台、角色分类与站点基础概念说明。 --- diff --git a/docs/guide/use/index.md b/docs/guide/use/index.md index 948f4194..3bc705d7 100644 --- a/docs/guide/use/index.md +++ b/docs/guide/use/index.md @@ -1,5 +1,5 @@ --- -title: 功能文档 -description: Halo 功能操作总览，涵盖文章、页面、附件、菜单、主题、插件、应用市场、用户权限、站点设置、备份恢复及商城管理。 +title: 常用模块 +description: Halo 基础功能操作总览，涵盖文章、页面、附件、菜单、主题、插件、应用市场、用户权限、站点设置及备份恢复。 overview: true --- diff --git a/docs/guide/use/user-center.md b/docs/guide/use/user-center.md index b9099f63..8fcb5e50 100644 --- a/docs/guide/use/user-center.md +++ b/docs/guide/use/user-center.md @@ -84,4 +84,4 @@ Halo 默认为个人中心提供了管理个人文章的功能，每个用户都 ## 商城 -Halo 商城版会在个人中心增加订单、收货地址和优惠券功能，使用方法参见[商城客户中心](./shop/customer-center.md)。 +Halo 商城版会在个人中心增加订单、收货地址和优惠券功能，使用方法参见[商城客户中心](../shop/customer-center.md)。 diff --git a/docs/index.mdx b/docs/index.mdx index c4b22c21..13529af4 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -97,7 +97,7 @@ import { Link } from "@rspress/core/runtime"; 插件 附件 系统设置 - 常见问题 + 常见问题 查看全部功能文档 @@ -127,7 +127,7 @@ import { Link } from "@rspress/core/runtime"; 查看常见问题，或到社区论坛提问。 diff --git a/edgeone.json b/edgeone.json index 0e89c115..2397755d 100644 --- a/edgeone.json +++ b/edgeone.json @@ -4,6 +4,36 @@ "outputDirectory": "./build", "nodeVersion": "24.18.0", "redirects": [ + { + "source": "/guide/use/shop", + "destination": "/guide/shop", + "statusCode": 301 + }, + { + "source": "/guide/use/shop/*", + "destination": "/guide/shop/:splat", + "statusCode": 301 + }, + { + "source": "/guide/use/faq", + "destination": "/guide/faq", + "statusCode": 301 + }, + { + "source": "/user-guide/shop", + "destination": "/guide/shop", + "statusCode": 301 + }, + { + "source": "/user-guide/shop/*", + "destination": "/guide/shop/:splat", + "statusCode": 301 + }, + { + "source": "/user-guide/faq", + "destination": "/guide/faq", + "statusCode": 301 + }, { "source": "/next/getting-started/install/*", "destination": "/guide/install/:splat", diff --git a/i18n.json b/i18n.json new file mode 100644 index 00000000..a4241ad3 --- /dev/null +++ b/i18n.json @@ -0,0 +1,8 @@ +{ + "overview.filterPlaceholderText": { + "zh": "搜索内容" + }, + "overview.filterNoResultText": { + "zh": "未找到匹配的内容" + } +} diff --git a/rstack.config.ts b/rstack.config.ts index 6bcb2248..ee107342 100644 --- a/rstack.config.ts +++ b/rstack.config.ts @@ -39,6 +39,9 @@ define.doc(async () => { route: { cleanUrls: true, }, + mediumZoom: { + selector: ".rspress-doc img:not(.no-zoom)", + }, markdown: { showLineNumbers: true, link: { diff --git a/theme/components/EditLink.tsx b/theme/components/EditLink.tsx new file mode 100644 index 00000000..a1c72a2d --- /dev/null +++ b/theme/components/EditLink.tsx @@ -0,0 +1,25 @@ +import { Link, useEditLink } from "@rspress/core/theme-original"; +import MingcuteEdit3Line from "~icons/mingcute/edit-3-line"; + +interface EditLinkProps { + isOutline?: boolean; +} + +export function EditLink({ isOutline = false }: EditLinkProps) { + const editLink = useEditLink(); + + if (!editLink) { + return null; + } + + const className = isOutline + ? "rp-outline__action-row rp-edit-link" + : "rp-edit-link rp-edit-link--footer"; + + return ( + +