@ouraihub/preset-docs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OurAI Hub
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,241 @@
+# @ouraihub/preset-docs
+
+文档站点预设配置，提供开箱即用的文档站点解决方案。
+
+## 特性
+
+- ✨ **优化可读性** - 更大的字体、更宽松的行高，专为长文档阅读优化
+- 🎨 **专业配色** - 适合技术文档的配色方案，支持亮色/暗色主题
+- 📦 **完整组件** - 侧边栏、目录、代码块、警告框、面包屑等文档专用组件
+- 📐 **响应式布局** - 适配桌面、平板、移动端的布局配置
+- 🔍 **搜索优化** - 内置搜索页面布局和样式
+- 📚 **API 参考** - 专门的 API 文档页面布局
+
+## 安装
+
+```bash
+pnpm add @ouraihub/preset-docs
+```
+
+## 使用
+
+### 基础使用
+
+```typescript
+import { docsPreset } from '@ouraihub/preset-docs';
+
+const config = {
+  presets: [docsPreset],
+};
+```
+
+### 使用特定布局
+
+```typescript
+import { 
+  docsLayout,           // 标准文档页布局
+  apiReferenceLayout,   // API 参考页布局
+  searchLayout,         // 搜索页布局
+  fullWidthLayout       // 全宽布局（首页等）
+} from '@ouraihub/preset-docs/layouts';
+
+// 在你的页面中使用
+const pageConfig = {
+  layout: docsLayout,
+};
+```
+
+### 自定义设计令牌
+
+```typescript
+import { docsPreset } from '@ouraihub/preset-docs';
+import type { Preset } from '@ouraihub/core/preset';
+
+const customPreset: Preset = {
+  ...docsPreset,
+  tokens: {
+    ...docsPreset.tokens,
+    colors: {
+      ...docsPreset.tokens?.colors,
+      primary: {
+        base: 'hsl(200, 100%, 50%)',  // 自定义主色
+      },
+    },
+  },
+};
+```
+
+### 自定义组件配置
+
+```typescript
+import { docsPreset, docsComponents } from '@ouraihub/preset-docs';
+import type { Preset } from '@ouraihub/core/preset';
+
+const customPreset: Preset = {
+  ...docsPreset,
+  components: docsComponents.map(component => {
+    if (component.name === 'Sidebar') {
+      return {
+        ...component,
+        defaults: {
+          ...component.defaults,
+          width: '20rem',  // 更宽的侧边栏
+        },
+      };
+    }
+    return component;
+  }),
+};
+```
+
+## 包含的组件
+
+### Sidebar（侧边栏）
+- 可折叠导航
+- 固定定位支持
+- 响应式隐藏
+
+### TableOfContents（目录）
+- 自动生成目录
+- 可配置深度
+- 固定定位支持
+
+### CodeBlock（代码块）
+- 语法高亮
+- 行号显示
+- 复制按钮
+- 行高亮
+
+### Callout（警告框）
+- 多种类型：note、tip、warning、danger
+- 可选图标
+- 可折叠
+
+### Breadcrumb（面包屑）
+- 自动路径生成
+- 可配置分隔符
+- 最大项数限制
+
+### SearchModal（搜索模态框）
+- 快捷键支持
+- 结果高亮
+- 键盘导航
+
+### ApiReference（API 参考）
+- 类型展示
+- 示例代码
+- 可展开/折叠
+
+### Pagination（分页）
+- 上一页/下一页
+- 可选页码
+
+## 设计令牌
+
+### 颜色
+
+```css
+/* 主色调 */
+--ui-primary: hsl(212, 100%, 48%);
+
+/* 代码高亮 */
+--ui-code-background: hsl(220, 13%, 18%);
+--ui-code-text: hsl(220, 14%, 96%);
+
+/* 语义化颜色 */
+--ui-note-background: hsl(212, 100%, 96%);
+--ui-tip-background: hsl(142, 76%, 96%);
+--ui-warning-background: hsl(38, 92%, 96%);
+--ui-danger-background: hsl(0, 84%, 96%);
+```
+
+### 间距
+
+```css
+/* 内容间距 */
+--ui-content-sm: 1rem;
+--ui-content-md: 1.5rem;
+--ui-content-lg: 2rem;
+
+/* 布局宽度 */
+--ui-sidebar-width: 16rem;
+--ui-toc-width: 14rem;
+--ui-content-max-width: 48rem;
+```
+
+### 字体
+
+```css
+/* 字体大小 */
+--ui-body-base: 1rem;
+--ui-h1: 2.5rem;
+--ui-h2: 2rem;
+--ui-h3: 1.5rem;
+
+/* 行高 */
+--ui-line-height-normal: 1.6;
+--ui-line-height-heading: 1.3;
+--ui-line-height-code: 1.7;
+```
+
+## 布局配置
+
+### 文档页布局
+
+```typescript
+{
+  type: 'flex',
+  maxWidth: '80rem',
+  areas: {
+    sidebar: { width: '16rem' },
+    content: { maxWidth: '48rem' },
+    toc: { width: '14rem' },
+  }
+}
+```
+
+### API 参考页布局
+
+```typescript
+{
+  type: 'flex',
+  maxWidth: '80rem',
+  areas: {
+    sidebar: { width: '16rem' },
+    content: { maxWidth: '60rem' },
+  }
+}
+```
+
+### 搜索页布局
+
+```typescript
+{
+  type: 'stack',
+  maxWidth: '48rem',
+  areas: {
+    searchBar: { width: '100%' },
+    results: { width: '100%' },
+  }
+}
+```
+
+## 响应式断点
+
+```typescript
+{
+  sm: '640px',   // 移动端
+  md: '768px',   // 平板
+  lg: '1024px',  // 桌面
+  xl: '1280px',  // 大屏
+}
+```
+
+## 依赖
+
+- `@ouraihub/core` - 核心类型定义
+- `@ouraihub/tokens` - 基础设计令牌
+
+## License
+
+MIT

package/dist/cjs/components.cjs

@@ -0,0 +1,195 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/components.ts
+var components_exports = {};
+__export(components_exports, {
+  docsComponents: () => docsComponents
+});
+module.exports = __toCommonJS(components_exports);
+var docsComponents = [
+  {
+    name: "Sidebar",
+    enabled: true,
+    defaults: {
+      width: "16rem",
+      collapsible: true,
+      position: "left",
+      sticky: true
+    },
+    styles: {
+      background: "var(--ui-sidebar-background)",
+      border: "1px solid var(--ui-sidebar-border)",
+      padding: "var(--ui-space-4)"
+    },
+    variants: {
+      collapsed: {
+        width: "4rem"
+      },
+      floating: {
+        position: "fixed",
+        shadow: "var(--ui-shadow-dropdown)"
+      }
+    }
+  },
+  {
+    name: "TableOfContents",
+    enabled: true,
+    defaults: {
+      width: "14rem",
+      position: "right",
+      sticky: true,
+      maxDepth: 3
+    },
+    styles: {
+      fontSize: "var(--ui-text-sm)",
+      lineHeight: "var(--ui-line-height-relaxed)"
+    },
+    variants: {
+      compact: {
+        maxDepth: 2,
+        fontSize: "var(--ui-text-xs)"
+      }
+    }
+  },
+  {
+    name: "CodeBlock",
+    enabled: true,
+    defaults: {
+      theme: "dark",
+      showLineNumbers: true,
+      copyButton: true,
+      highlightLines: []
+    },
+    styles: {
+      background: "var(--ui-code-background)",
+      color: "var(--ui-code-text)",
+      fontFamily: "var(--ui-font-mono)",
+      fontSize: "var(--ui-code-base)",
+      lineHeight: "var(--ui-line-height-code)",
+      borderRadius: "var(--ui-radius-lg)",
+      padding: "var(--ui-space-4)"
+    },
+    variants: {
+      inline: {
+        display: "inline",
+        padding: "0.125rem 0.375rem",
+        borderRadius: "var(--ui-radius-sm)"
+      }
+    }
+  },
+  {
+    name: "Callout",
+    enabled: true,
+    defaults: {
+      type: "note",
+      icon: true,
+      collapsible: false
+    },
+    styles: {
+      borderRadius: "var(--ui-radius-md)",
+      padding: "var(--ui-space-4)",
+      borderLeft: "4px solid"
+    },
+    variants: {
+      note: {
+        background: "var(--ui-note-background)",
+        borderColor: "var(--ui-note-border)",
+        color: "var(--ui-note-text)"
+      },
+      tip: {
+        background: "var(--ui-tip-background)",
+        borderColor: "var(--ui-tip-border)",
+        color: "var(--ui-tip-text)"
+      },
+      warning: {
+        background: "var(--ui-warning-background)",
+        borderColor: "var(--ui-warning-border)",
+        color: "var(--ui-warning-text)"
+      },
+      danger: {
+        background: "var(--ui-danger-background)",
+        borderColor: "var(--ui-danger-border)",
+        color: "var(--ui-danger-text)"
+      }
+    }
+  },
+  {
+    name: "Breadcrumb",
+    enabled: true,
+    defaults: {
+      separator: "/",
+      showHome: true,
+      maxItems: 5
+    },
+    styles: {
+      fontSize: "var(--ui-text-sm)",
+      color: "var(--ui-text-secondary)",
+      padding: "var(--ui-space-2) 0"
+    },
+    variants: {
+      compact: {
+        maxItems: 3,
+        separator: ">"
+      }
+    }
+  },
+  {
+    name: "SearchModal",
+    enabled: true,
+    defaults: {
+      placeholder: "Search documentation...",
+      hotkey: "ctrl+k",
+      maxResults: 10
+    },
+    styles: {
+      background: "var(--ui-background)",
+      borderRadius: "var(--ui-radius-xl)",
+      shadow: "var(--ui-shadow-modal)",
+      padding: "var(--ui-space-6)"
+    }
+  },
+  {
+    name: "ApiReference",
+    enabled: true,
+    defaults: {
+      showTypes: true,
+      showExamples: true,
+      expandable: true
+    },
+    styles: {
+      borderRadius: "var(--ui-radius-md)",
+      border: "1px solid var(--ui-border)",
+      padding: "var(--ui-space-4)"
+    }
+  },
+  {
+    name: "Pagination",
+    enabled: true,
+    defaults: {
+      showPrevNext: true,
+      showPageNumbers: false
+    },
+    styles: {
+      padding: "var(--ui-space-8) 0",
+      borderTop: "1px solid var(--ui-border)"
+    }
+  }
+];
+//# sourceMappingURL=components.cjs.map

package/dist/cjs/components.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/components.ts"],
+  "sourcesContent": ["import type { ComponentConfig } from '@ouraihub/core/preset';\n\n/**\n * \u6587\u6863\u7AD9\u70B9\u7EC4\u4EF6\u914D\u7F6E\n * \n * \u63D0\u4F9B\u6587\u6863\u573A\u666F\u5E38\u7528\u7EC4\u4EF6\u7684\u9884\u8BBE\u914D\u7F6E\n */\nexport const docsComponents: ComponentConfig[] = [\n  {\n    name: 'Sidebar',\n    enabled: true,\n    defaults: {\n      width: '16rem',\n      collapsible: true,\n      position: 'left',\n      sticky: true,\n    },\n    styles: {\n      background: 'var(--ui-sidebar-background)',\n      border: '1px solid var(--ui-sidebar-border)',\n      padding: 'var(--ui-space-4)',\n    },\n    variants: {\n      collapsed: {\n        width: '4rem',\n      },\n      floating: {\n        position: 'fixed',\n        shadow: 'var(--ui-shadow-dropdown)',\n      },\n    },\n  },\n  \n  {\n    name: 'TableOfContents',\n    enabled: true,\n    defaults: {\n      width: '14rem',\n      position: 'right',\n      sticky: true,\n      maxDepth: 3,\n    },\n    styles: {\n      fontSize: 'var(--ui-text-sm)',\n      lineHeight: 'var(--ui-line-height-relaxed)',\n    },\n    variants: {\n      compact: {\n        maxDepth: 2,\n        fontSize: 'var(--ui-text-xs)',\n      },\n    },\n  },\n  \n  {\n    name: 'CodeBlock',\n    enabled: true,\n    defaults: {\n      theme: 'dark',\n      showLineNumbers: true,\n      copyButton: true,\n      highlightLines: [],\n    },\n    styles: {\n      background: 'var(--ui-code-background)',\n      color: 'var(--ui-code-text)',\n      fontFamily: 'var(--ui-font-mono)',\n      fontSize: 'var(--ui-code-base)',\n      lineHeight: 'var(--ui-line-height-code)',\n      borderRadius: 'var(--ui-radius-lg)',\n      padding: 'var(--ui-space-4)',\n    },\n    variants: {\n      inline: {\n        display: 'inline',\n        padding: '0.125rem 0.375rem',\n        borderRadius: 'var(--ui-radius-sm)',\n      },\n    },\n  },\n  \n  {\n    name: 'Callout',\n    enabled: true,\n    defaults: {\n      type: 'note',\n      icon: true,\n      collapsible: false,\n    },\n    styles: {\n      borderRadius: 'var(--ui-radius-md)',\n      padding: 'var(--ui-space-4)',\n      borderLeft: '4px solid',\n    },\n    variants: {\n      note: {\n        background: 'var(--ui-note-background)',\n        borderColor: 'var(--ui-note-border)',\n        color: 'var(--ui-note-text)',\n      },\n      tip: {\n        background: 'var(--ui-tip-background)',\n        borderColor: 'var(--ui-tip-border)',\n        color: 'var(--ui-tip-text)',\n      },\n      warning: {\n        background: 'var(--ui-warning-background)',\n        borderColor: 'var(--ui-warning-border)',\n        color: 'var(--ui-warning-text)',\n      },\n      danger: {\n        background: 'var(--ui-danger-background)',\n        borderColor: 'var(--ui-danger-border)',\n        color: 'var(--ui-danger-text)',\n      },\n    },\n  },\n  \n  {\n    name: 'Breadcrumb',\n    enabled: true,\n    defaults: {\n      separator: '/',\n      showHome: true,\n      maxItems: 5,\n    },\n    styles: {\n      fontSize: 'var(--ui-text-sm)',\n      color: 'var(--ui-text-secondary)',\n      padding: 'var(--ui-space-2) 0',\n    },\n    variants: {\n      compact: {\n        maxItems: 3,\n        separator: '>',\n      },\n    },\n  },\n  \n  {\n    name: 'SearchModal',\n    enabled: true,\n    defaults: {\n      placeholder: 'Search documentation...',\n      hotkey: 'ctrl+k',\n      maxResults: 10,\n    },\n    styles: {\n      background: 'var(--ui-background)',\n      borderRadius: 'var(--ui-radius-xl)',\n      shadow: 'var(--ui-shadow-modal)',\n      padding: 'var(--ui-space-6)',\n    },\n  },\n  \n  {\n    name: 'ApiReference',\n    enabled: true,\n    defaults: {\n      showTypes: true,\n      showExamples: true,\n      expandable: true,\n    },\n    styles: {\n      borderRadius: 'var(--ui-radius-md)',\n      border: '1px solid var(--ui-border)',\n      padding: 'var(--ui-space-4)',\n    },\n  },\n  \n  {\n    name: 'Pagination',\n    enabled: true,\n    defaults: {\n      showPrevNext: true,\n      showPageNumbers: false,\n    },\n    styles: {\n      padding: 'var(--ui-space-8) 0',\n      borderTop: '1px solid var(--ui-border)',\n    },\n  },\n];\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAOO,IAAM,iBAAoC;AAAA,EAC/C;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,OAAO;AAAA,MACP,aAAa;AAAA,MACb,UAAU;AAAA,MACV,QAAQ;AAAA,IACV;AAAA,IACA,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,SAAS;AAAA,IACX;AAAA,IACA,UAAU;AAAA,MACR,WAAW;AAAA,QACT,OAAO;AAAA,MACT;AAAA,MACA,UAAU;AAAA,QACR,UAAU;AAAA,QACV,QAAQ;AAAA,MACV;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,OAAO;AAAA,MACP,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,UAAU;AAAA,IACZ;AAAA,IACA,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,YAAY;AAAA,IACd;AAAA,IACA,UAAU;AAAA,MACR,SAAS;AAAA,QACP,UAAU;AAAA,QACV,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,OAAO;AAAA,MACP,iBAAiB;AAAA,MACjB,YAAY;AAAA,MACZ,gBAAgB,CAAC;AAAA,IACnB;AAAA,IACA,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,OAAO;AAAA,MACP,YAAY;AAAA,MACZ,UAAU;AAAA,MACV,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,SAAS;AAAA,IACX;AAAA,IACA,UAAU;AAAA,MACR,QAAQ;AAAA,QACN,SAAS;AAAA,QACT,SAAS;AAAA,QACT,cAAc;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,MAAM;AAAA,MACN,MAAM;AAAA,MACN,aAAa;AAAA,IACf;AAAA,IACA,QAAQ;AAAA,MACN,cAAc;AAAA,MACd,SAAS;AAAA,MACT,YAAY;AAAA,IACd;AAAA,IACA,UAAU;AAAA,MACR,MAAM;AAAA,QACJ,YAAY;AAAA,QACZ,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,MACA,KAAK;AAAA,QACH,YAAY;AAAA,QACZ,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,MACA,SAAS;AAAA,QACP,YAAY;AAAA,QACZ,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,MACA,QAAQ;AAAA,QACN,YAAY;AAAA,QACZ,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,WAAW;AAAA,MACX,UAAU;AAAA,MACV,UAAU;AAAA,IACZ;AAAA,IACA,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,OAAO;AAAA,MACP,SAAS;AAAA,IACX;AAAA,IACA,UAAU;AAAA,MACR,SAAS;AAAA,QACP,UAAU;AAAA,QACV,WAAW;AAAA,MACb;AAAA,IACF;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,aAAa;AAAA,MACb,QAAQ;AAAA,MACR,YAAY;AAAA,IACd;AAAA,IACA,QAAQ;AAAA,MACN,YAAY;AAAA,MACZ,cAAc;AAAA,MACd,QAAQ;AAAA,MACR,SAAS;AAAA,IACX;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,WAAW;AAAA,MACX,cAAc;AAAA,MACd,YAAY;AAAA,IACd;AAAA,IACA,QAAQ;AAAA,MACN,cAAc;AAAA,MACd,QAAQ;AAAA,MACR,SAAS;AAAA,IACX;AAAA,EACF;AAAA,EAEA;AAAA,IACE,MAAM;AAAA,IACN,SAAS;AAAA,IACT,UAAU;AAAA,MACR,cAAc;AAAA,MACd,iBAAiB;AAAA,IACnB;AAAA,IACA,QAAQ;AAAA,MACN,SAAS;AAAA,MACT,WAAW;AAAA,IACb;AAAA,EACF;AACF;",
+  "names": []
+}