ForcePilot/docs/v0.4.0/advanced/branding.md
Wenjie Zhang 90bfd20d8d refactor: 重构:将项目重命名为 Yuxi 并更新模块路径
- 在所有文档和配置中将品牌从 "Yuxi-Know" 重命名为 "Yuxi"
- 将 Python 导入路径从 `src.*` 更新为 `yuxi.*` 以保持后端包的一致性
- 将 Web 包名称从 `yuxi-know-web` 更新为 `yuxi-web`

此更改与后端代码迁移至 backend/ 目录保持一致。
2026-03-24 11:08:31 +08:00

1.6 KiB
Raw Blame History

品牌自定义

系统支持完整的品牌信息自定义,包括 Logo、组织名称、版权信息等。

配置方法

1. 复制模板文件

cp backend/package/yuxi/config/static/info.template.yaml backend/package/yuxi/config/static/info.local.yaml

2. 编辑品牌信息

backend/package/yuxi/config/static/info.local.yaml 中配置:

<<< @/../backend/package/yuxi/config/static/info.template.yaml

上述中提到的 ICON 预设了下面这些,如果需要更多的 ICONS可以手动从 lucide-vue-next 中引入。

<<< @/../web/src/views/HomeView.vue#icon_mapping{js}

3. 环境变量配置

.env 文件中指定配置文件路径:

YUXI_BRAND_FILE_PATH=backend/package/yuxi/config/static/info.local.yaml

::: tip 配置优先级 info.local.yaml > info.template.yaml(默认) :::

样式定制

系统配色主要保存在 web/src/assets/css/base.css 中:

  • 替换 --main-* 相关变量即可改变配色
  • 支持主题色、辅助色等完整定制
  • 实时预览,无需重启服务

主要变量:

:root {
  --main-color: #1890ff;        /* 主色调 */
  --main-1000: #f0f2f5;          /* 色板 */
  --main-900: #e6f7ff;           /* 色板 */
  /* ... 其他色板 */
}

此外web/src/stores/theme.js 中也包含了主题相关的配置(需要修改 colorPrimary),可根据需要修改。

修改首页

首页提供了一个插槽组件 web/src/components/ProjectOverview.vue,可以在该组件中自定义项目介绍,当前为空文件。(借助 AI 编程可以设计出更好看的首页的)