@docubuild-io/design

中文文档
0.1.0发布于 2026/10/30UNLICENSEDTypeScriptES Module近 30 天下载 1960

DocuBuild's design system: tokens, Svelte components and design guidelines.

原始使用文档
文档目录4 节
  1. Install
  2. Set up Tailwind
  3. Use
  4. Licence

@docubuild-io/design

DocuBuild's design system: the tokens, the Svelte components and the design guidelines every DocuBuild product app is built with. Published for DocuBuild's own apps; see the licence below.

Preview: https://design.docubuild.io

Install

pnpm add @docubuild-io/design bits-ui svelte-sonner

svelte, bits-ui and svelte-sonner are peer dependencies: an app holds exactly one copy of each.

Set up Tailwind

@import 'tailwindcss';
@import 'tw-animate-css';
@plugin '@tailwindcss/forms';
@import '@docubuild-io/design/theme.css';
@source '../../node_modules/@docubuild-io/design/dist/**/*.{svelte,js}';

theme.css carries the tokens as Tailwind theme variables (bg-panel, text-ink, text-body, h-control-md, z-modal …), loads Geist and Geist Mono, and adds the base layer. The @source line lets Tailwind see the classes inside the components.

Use

<script lang="ts">
  import {Button} from '@docubuild-io/design/ui/button'
  import * as Dialog from '@docubuild-io/design/ui/dialog'
  import {StatusTag} from '@docubuild-io/design/patterns/status-tag'
</script>
ExportHolds
./theme.cssThe default theme for Tailwind v4, with the base layer
./tokensThe default theme's values as an object (hex colours), for email, canvas and charts
./ui/<name>The primitives, on bits-ui
./patterns/<name>DocuBuild patterns
./utilscn and tv, taught the theme's names
./guidelines/<file>The design guidelines, as markdown

Start with guidelines/README.md.

Licence

UNLICENSED. The source is visible, but no licence to use, copy or modify it is granted. The DocuBuild name and logo are trademarks. The bundled Geist fonts are under the SIL Open Font License.

版本与发布记录

@docubuild-io/design 共发布 12 个版本,首次发布于 2026/10/29;过去 12 个月发布了 12 个版本。

版本发布日期距今
0.1.0latest2026/10/3016 天前
0.1.0-snapshot-71ed9c53fdfb657344615ad42db31994105db0b9snapshot2026/10/3016 天前
0.1.0-snapshot-5aa016ecd2ac94bbf1238033448f893d65568daf2026/10/3016 天前
0.1.0-snapshot-addac34d97644e8a9344991a10dac59f05d567f02026/10/3016 天前
0.1.0-snapshot-1bf04521f1300804bca463f52e1efdac7de46cf02026/10/3016 天前
0.1.0-snapshot-c1b0a6aa18932a1565588e8f8bf4e41aa4237d7d2026/10/3016 天前

关于 @docubuild-io/design 的常见问题

@docubuild-io/design 是什么?

DocuBuild's design system: tokens, Svelte components and design guidelines.

如何安装 @docubuild-io/design?

在项目目录运行 npm install @docubuild-io/design,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:svelte(^5.57.0)、bits-ui(^2.19.0)、svelte-sonner(^1.2.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@docubuild-io/design 支持 TypeScript 吗?

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

@docubuild-io/design 支持 ESM 还是 CommonJS?

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

@docubuild-io/design 可以商用吗?

@docubuild-io/design 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@docubuild-io/design 的下载量有多少?

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

@docubuild-io/design 还在维护吗?

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