@gokberknur/design-system

中文文档
0.31.0发布于 2026/11/09MITTypeScriptES Module近 30 天下载 3890

A personal, minimal & editorial design system: framework-agnostic gok-* web components + design tokens, built with Lit. One green accent, Geist, WCAG AAA, light/dark.

原始使用文档
文档目录6 节
  1. Install
  2. Quick start
  3. Theming
  4. What's inside
  5. Explore
  6. Licence

gökberk design system

npm license: MIT types

I'm not a brand. I built the design system anyway — and I use it on my hobby projects.

gökberk is a personal UI identity, with a minimal approach and minimal accent colours. The components are framework-agnostic web components built with Lit, so they can be used with any popular JavaScript library — React, Angular, Vue, Svelte, or vanilla JS.

Live site · See it in use

Install

npm i @gokberknur/design-system

Rebranding: change the accent, neutrals, font or corner, and check contrast with npx gok-check-brand; see docs/rebranding.md.

Browser support: see docs/browser-support.md.

Accessibility: see the WCAG 2.2 conformance report.

Quick start

Load the foundation once, then import the elements you use:

import '@gokberknur/design-system/standalone.css'; // fonts + tokens + typography + layout
import '@gokberknur/design-system/gok-button';      // register an element (side-effect import)
<gok-button>Get started</gok-button>

The component reads the tokens, so theming and density work the moment the CSS is loaded.

Theming

One attribute on the root re-themes everything (it cascades into shadow DOM):

<html data-theme="dark" data-density="compact"></html>

data-theme is light · dark · auto; data-density is regular · compact. Every colour pairing is verified WCAG AAA on both themes.

What's inside

64 custom elements across 51 families, plus the foundation layer — design tokens, a responsive type scale, self-hosted Geist. Grouped as Actions & Inputs · Feedback · Navigation · Overlay · Data display · Layout.

  • gok- element prefix · --gok-* token prefix.
  • Each element ships axe-clean, with bundled TypeScript types and a custom-elements.json manifest.
  • Tree-shakeable — import only what you use, or @gokberknur/design-system/standalone to register everything at once.

Explore

Licence

MIT (code). Geist & Geist Mono are under the SIL Open Font License 1.1. Built by Gökberk Nur.

版本与发布记录

@gokberknur/design-system 共发布 44 个版本,首次发布于 2026/06/25;过去 12 个月发布了 44 个版本。

版本发布日期距今
0.31.0latest2026/11/097 天前
0.30.02026/11/079 天前
0.29.02026/11/0511 天前
0.28.02026/11/0511 天前
0.27.02026/11/0511 天前
0.26.02026/11/0511 天前

其他发布通道:beta → 0.12.0-beta.0。

关于 @gokberknur/design-system 的常见问题

@gokberknur/design-system 是什么?

A personal, minimal & editorial design system: framework-agnostic gok-* web components + design tokens, built with Lit. One green accent, Geist, WCAG AAA, light/dark.

如何安装 @gokberknur/design-system?

在项目目录运行 npm install @gokberknur/design-system,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 gok-check-brand,可以用 npx gok-check-brand 直接运行。

@gokberknur/design-system 支持 TypeScript 吗?

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

@gokberknur/design-system 支持 ESM 还是 CommonJS?

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

@gokberknur/design-system 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gokberknur/design-system 可以商用吗?

@gokberknur/design-system 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gokberknur/design-system 的下载量有多少?

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

@gokberknur/design-system 还在维护吗?

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