feat(docs): add bilingual package documentation site

2026-09-20 15:53:28 +08:00
parent 60f6f1fb1a
commit dc80bd8ae0
111 changed files with 6531 additions and 0 deletions
@@ -0,0 +1,30 @@
+---
+title: 选择组件
+description: 按职责选择基础组件，而不是导入一个庞大的统一组件入口。
+order: 11
+toc:
+  - id: forms
+    title: 表单与输入
+  - id: overlays
+    title: 浮层与菜单
+  - id: content
+    title: 内容与反馈
+  - id: icons
+    title: 图标
+---
+
+## 表单与输入 {#forms}
+
+普通表单可使用 `Button`、`Input`、`Textarea`、`Field` 和 `Label`。选择类输入可加入 `Checkbox`、`RadioGroup`、`Switch` 或 `Slider`；更丰富的选择场景可使用 `Select`、`Combobox`、`Command` 或 `Calendar`。
+
+## 浮层与菜单 {#overlays}
+
+`Dialog`、`AlertDialog`、`Sheet` 和 `Drawer` 用于模态界面。`Popover`、`HoverCard` 和 `Tooltip` 用于锚定式信息展示，菜单模块则覆盖上下文菜单、下拉菜单、菜单栏和导航模式。
+
+## 内容与反馈 {#content}
+
+卡片、列表项、表格、图表、进度条、骨架屏、加载器、空状态、消息和 Toast 构成通用展示词汇。Accordion、Collapsible、Tabs、Carousel 和 Pagination 用于组织更大规模的内容。
+
+## 图标 {#icons}
+
+从 `@workspace/ui/components/icon` 导入具名图标。该模块统一了 `@icones/react` 的图标词汇，使应用和各个包使用同一图标来源。
@@ -0,0 +1,39 @@
+---
+title: 项目配置
+description: 导入全局样式，并从显式组件子路径开始使用。
+order: 10
+toc:
+  - id: import-styles
+    title: 导入样式
+  - id: import-a-component
+    title: 导入组件
+  - id: entry-points
+    title: 包入口
+---
+
+## 导入样式 {#import-styles}
+
+在应用入口中导入一次全局样式：
+
+```ts
+import "@workspace/ui/globals.css"
+```
+
+它提供组件所需的共享 Tailwind 层、设计变量、字体配置和工具类。
+
+## 导入组件 {#import-a-component}
+
+```tsx
+import { Button } from "@workspace/ui/components/button"
+
+export function SaveButton() {
+  return <Button>保存</Button>
+}
+```
+
+## 包入口 {#entry-points}
+
+- `@workspace/ui/components/*` 导出单个组件模块。
+- `@workspace/ui/hooks/*` 导出可复用的交互和媒体查询状态。
+- `@workspace/ui/lib/utils` 导出共享的类名组合工具。
+- `@workspace/ui/locales/*` 导出指定语言的词典。