Files
probably-rendering-one-more…/packages/brand/README.md
T
codex-bot 6654a1456b
Unified application CI and deployment / verify-and-release (pull_request) Waiting to run
python CI and deployment / verify-and-deploy (pull_request) Successful in 1m12s
Unify Wiki and Studio application and simplify deployment
2026-11-04 03:41:16 +08:00

38 lines
2.3 KiB
Markdown

# 啡跃 Endoleap 品牌包
本包把已选定的「摩卡奶霜」配色、四套正式主题和固定轮廓 Logo 放在同一个 workspace 包中。它提供 Tailwind CSS v4 / shadcn/ui 的主题接口及静态图片,不安装组件,也不自动重设应用页面。
## 文档入口
- [品牌与包边界](docs/overview.md)
- [配色、组件状态与深色主题](docs/colors.md)
- [Tailwind CSS、shadcn/ui 与包导入](docs/integration.md)
- [Logo、平台图片与修改流程](docs/logo.md)
`tokens/palette.json` 是色值来源;四份主题 JSON 引用色板键;`tokens/geometry.json` 是唯一 Logo 路径来源。`src/themes.css` 是可直接导入的源样式,一致性由测试核对;`dist/` 仅在远程 CI 构建,不提交。
```css
@import "tailwindcss";
@import "@endoleap/brand/themes.css";
@import "@endoleap/brand/tailwind.css";
```
```tsx
// 在主题根节点选择正式主题;应用负责持久化和切换。
<main data-theme="canvas-dark" className="bg-background text-foreground">
<button className="bg-primary text-primary-foreground hover:bg-primary-hover">
开始创作
</button>
</main>
```
主题名:`home-light`、`home-dark`、`canvas-light`、`canvas-dark`。没有 `drafts`、`proposed` 或隐式跟随系统的规则。`.dark` 兼容默认首页深色;显式 `data-theme` 优先。使用 `dark:` 工具类时,一个文档根节点只选择一个明暗主题,不在 `.dark` 祖先下嵌套浅色 `dark:` 变体。
## 验证
可进行的本地轻量检查:`node --test packages/brand/tests/brand.test.mjs`。它只读取源码和资产,检查主题、对比度、SVG 路径及 PNG/ICO 文件头,不编译和输出产物。
品牌包不提供独立 Docker 镜像或常驻服务,也不再运行专用品牌 CI 工作流。Wiki 和 Studio 通过 `workspace:*` 使用本包,品牌资源随消费应用的 Docker 构建处理,并由应用类型检查、测试和构建验证接入。
原专用工作流中的品牌导出一致性、单独 Tailwind/TypeScript 测试和 72 个 PNG 与 SVG 逐像素比较不再自动运行;相关脚本与测试文件保留,不能将应用检查视为对这些检查的等价替代。需要这些完整检查时,仍须在已确认的远程 runner 执行,不在本机运行 `build` / `test:tailwind` / `test:types` / `test:assets`。