@growthpath/brand-kit

中文文档
0.3.2发布于 2026/09/10TypeScriptES Module零依赖近 30 天下载 1.3万

Brand-neutral site foundation and chrome with brand-owned opaque palettes and fonts

原始使用文档
文档目录3 节
  1. Exports
  2. Install
  3. Verify and release

@growthpath/brand-kit

Brand Kit is the public framework-neutral design foundation for GrowthPath-owned websites. It owns the type scale, spacing, shapes, background, material, shadows, glows, and site chrome. Each consumer supplies fonts, logos, copy, opaque palette values, and the page width and gutter its site reads at.

Exports

  • foundation.css: semantic Tailwind v4 utilities and equivalent CSS properties
  • chrome.css: public-site navigation, buttons, footer, theme switch, and skip link
  • ambient: deterministic background shapes
  • contrast: WCAG contrast arithmetic for consumer contract tests
  • brand-template.css: a copy-only scaffold for a consumer's palette

Workspace imports resolve ambient and contrast to TypeScript source. Published imports resolve compiled files in dist. The release workflow applies publishConfig.exports to a staged manifest before packing because npm does not use that field as a manifest override.

Install

bun add @growthpath/brand-kit@^0.3.2
cp "$(node -p 'require.resolve("@growthpath/brand-kit/brand-template.css")')" src/styles/brand.css

Import the shared runtime before the consumer's palette:

@import 'tailwindcss';
@import '@growthpath/brand-kit/foundation.css';
@import '@growthpath/brand-kit/chrome.css';
@import './brand.css';

The public packages follow one 0.x compatibility rule. A breaking export or token change requires a minor bump. A compatible addition or fix requires a patch bump.

Verify and release

bun run --filter @growthpath/brand-kit lint
bun run --filter @growthpath/brand-kit typecheck
bun run --filter @growthpath/brand-kit test
bun run --filter @growthpath/brand-visuals test

The Brand Visuals test packs both public packages and builds the clean external fixture. Releases use the manual workflow and operator steps in docs/ops/package-releases.md.

版本与发布记录

@growthpath/brand-kit 共发布 5 个版本,首次发布于 2026/08/24;过去 12 个月发布了 5 个版本。

版本发布日期距今
0.3.2latest2026/09/102 个月前
0.3.12026/09/042 个月前
0.3.02026/09/022 个月前
0.2.02026/08/242 个月前
0.1.02026/08/242 个月前

关于 @growthpath/brand-kit 的常见问题

@growthpath/brand-kit 是什么?

Brand-neutral site foundation and chrome with brand-owned opaque palettes and fonts

如何安装 @growthpath/brand-kit?

在项目目录运行 npm install @growthpath/brand-kit,或使用 pnpm add / yarn add / bun add。

@growthpath/brand-kit 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@growthpath/brand-kit 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@growthpath/brand-kit 可以商用吗?

@growthpath/brand-kit 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@growthpath/brand-kit 的下载量有多少?

根据 npm 官方下载统计,@growthpath/brand-kit 在 2026/10/17 – 2026/11/15 这 30 天内被下载 13,212 次,日均约 440 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@growthpath/brand-kit 还在维护吗?

最新版本 0.3.2 发布于 2026/09/10(2 个月前);至今共发布 5 个版本,其中过去 12 个月发布了 5 个;首次发布于 2026/08/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。