Skip to content

Repository files navigation

English | 简体中文

DBX Themes

DBX 的社区应用主题仓库。本仓库定义公开的 DBX 主题标准、校验开发者提交的主题,并生成供 DBX 使用的主题目录。

主题必须是纯声明式数据。贡献内容可以包含颜色、元数据、预览图和许可证文本,但不能包含可执行 JavaScript、任意 CSS 或远程资源。

贡献主题

  1. Fork 本仓库。
  2. templates/theme/ 复制到 themes/<theme-id>/
  3. 修改 theme.json 中的元数据以及全部亮色、暗色颜色值。
  4. 添加尺寸为 1600x1000 的 preview-light.pngpreview-dark.png
  5. 确认 LICENSE 中包含主题使用的完整许可证文本。
  6. 执行校验命令并提交 Pull Request。
npm install
npm run build
npm run check

完整审核规则见 CONTRIBUTING.md,Token 定义见 docs/theme-v1.md

仓库结构

schemas/                 用于编辑器提示和 CI 校验的 JSON Schema
templates/theme/         开发者可直接复制的主题模板
themes/<theme-id>/       每个目录包含一套独立社区主题
scripts/                 校验脚本和确定性目录生成脚本
tests/                   主题标准与校验器测试
dist/catalog-v1.json     供 DBX 使用的生成目录

主题标准

DBX Theme v1 要求:

  • 使用稳定的 kebab-case 主题 ID;
  • 提供语义化版本和兼容的 DBX 版本信息;
  • 同时提供完整的亮色与暗色版本;
  • 完整填写 37 个公开语义颜色 Token;
  • 只能使用安全的十六进制颜色;
  • 前景色与背景色需要满足可访问性对比度要求;
  • 提供两张最新预览图和完整许可证文件。

公开 Token 与 DBX 内部 CSS 变量相互独立。DBX 负责将公开标准映射到内部实现,避免应用内部重构无谓破坏社区主题。

主题目录

dist/catalog-v1.json 由通过校验的主题清单自动生成,请勿手动修改。修改主题后执行 npm run build,并将生成结果一起提交。

开源协议

本仓库使用 Apache License 2.0。主题贡献者必须在各自主题目录的 LICENSE 中保留完整许可证文本;如果主题来源于其他项目,还需要遵守并保留原项目的授权与署名要求。

About

Theme presets and theme format examples for DBX.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages