@ouraihub/preset-docs 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +241 -0
- package/dist/cjs/components.cjs +195 -0
- package/dist/cjs/components.cjs.map +7 -0
- package/dist/cjs/index.cjs +483 -0
- package/dist/cjs/index.cjs.map +7 -0
- package/dist/cjs/layouts.cjs +131 -0
- package/dist/cjs/layouts.cjs.map +7 -0
- package/dist/cjs/tokens.cjs +183 -0
- package/dist/cjs/tokens.cjs.map +7 -0
- package/dist/esm/chunk-D5ZMUFJ5.mjs +163 -0
- package/dist/esm/chunk-D5ZMUFJ5.mjs.map +7 -0
- package/dist/esm/chunk-NMPQAUNP.mjs +111 -0
- package/dist/esm/chunk-NMPQAUNP.mjs.map +7 -0
- package/dist/esm/chunk-QKN5WBAL.mjs +175 -0
- package/dist/esm/chunk-QKN5WBAL.mjs.map +7 -0
- package/dist/esm/components.mjs +7 -0
- package/dist/esm/components.mjs.map +7 -0
- package/dist/esm/index.mjs +39 -0
- package/dist/esm/index.mjs.map +7 -0
- package/dist/esm/layouts.mjs +13 -0
- package/dist/esm/layouts.mjs.map +7 -0
- package/dist/esm/tokens.mjs +7 -0
- package/dist/esm/tokens.mjs.map +7 -0
- package/dist/types/components.d.ts +8 -0
- package/dist/types/components.d.ts.map +1 -0
- package/dist/types/index.d.ts +24 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/layouts.d.ts +18 -0
- package/dist/types/layouts.d.ts.map +1 -0
- package/dist/types/tokens.d.ts +12 -0
- package/dist/types/tokens.d.ts.map +1 -0
- package/package.json +64 -0
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
// src/components.ts
|
|
2
|
+
var docsComponents = [
|
|
3
|
+
{
|
|
4
|
+
name: "Sidebar",
|
|
5
|
+
enabled: true,
|
|
6
|
+
defaults: {
|
|
7
|
+
width: "16rem",
|
|
8
|
+
collapsible: true,
|
|
9
|
+
position: "left",
|
|
10
|
+
sticky: true
|
|
11
|
+
},
|
|
12
|
+
styles: {
|
|
13
|
+
background: "var(--ui-sidebar-background)",
|
|
14
|
+
border: "1px solid var(--ui-sidebar-border)",
|
|
15
|
+
padding: "var(--ui-space-4)"
|
|
16
|
+
},
|
|
17
|
+
variants: {
|
|
18
|
+
collapsed: {
|
|
19
|
+
width: "4rem"
|
|
20
|
+
},
|
|
21
|
+
floating: {
|
|
22
|
+
position: "fixed",
|
|
23
|
+
shadow: "var(--ui-shadow-dropdown)"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
name: "TableOfContents",
|
|
29
|
+
enabled: true,
|
|
30
|
+
defaults: {
|
|
31
|
+
width: "14rem",
|
|
32
|
+
position: "right",
|
|
33
|
+
sticky: true,
|
|
34
|
+
maxDepth: 3
|
|
35
|
+
},
|
|
36
|
+
styles: {
|
|
37
|
+
fontSize: "var(--ui-text-sm)",
|
|
38
|
+
lineHeight: "var(--ui-line-height-relaxed)"
|
|
39
|
+
},
|
|
40
|
+
variants: {
|
|
41
|
+
compact: {
|
|
42
|
+
maxDepth: 2,
|
|
43
|
+
fontSize: "var(--ui-text-xs)"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
name: "CodeBlock",
|
|
49
|
+
enabled: true,
|
|
50
|
+
defaults: {
|
|
51
|
+
theme: "dark",
|
|
52
|
+
showLineNumbers: true,
|
|
53
|
+
copyButton: true,
|
|
54
|
+
highlightLines: []
|
|
55
|
+
},
|
|
56
|
+
styles: {
|
|
57
|
+
background: "var(--ui-code-background)",
|
|
58
|
+
color: "var(--ui-code-text)",
|
|
59
|
+
fontFamily: "var(--ui-font-mono)",
|
|
60
|
+
fontSize: "var(--ui-code-base)",
|
|
61
|
+
lineHeight: "var(--ui-line-height-code)",
|
|
62
|
+
borderRadius: "var(--ui-radius-lg)",
|
|
63
|
+
padding: "var(--ui-space-4)"
|
|
64
|
+
},
|
|
65
|
+
variants: {
|
|
66
|
+
inline: {
|
|
67
|
+
display: "inline",
|
|
68
|
+
padding: "0.125rem 0.375rem",
|
|
69
|
+
borderRadius: "var(--ui-radius-sm)"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
name: "Callout",
|
|
75
|
+
enabled: true,
|
|
76
|
+
defaults: {
|
|
77
|
+
type: "note",
|
|
78
|
+
icon: true,
|
|
79
|
+
collapsible: false
|
|
80
|
+
},
|
|
81
|
+
styles: {
|
|
82
|
+
borderRadius: "var(--ui-radius-md)",
|
|
83
|
+
padding: "var(--ui-space-4)",
|
|
84
|
+
borderLeft: "4px solid"
|
|
85
|
+
},
|
|
86
|
+
variants: {
|
|
87
|
+
note: {
|
|
88
|
+
background: "var(--ui-note-background)",
|
|
89
|
+
borderColor: "var(--ui-note-border)",
|
|
90
|
+
color: "var(--ui-note-text)"
|
|
91
|
+
},
|
|
92
|
+
tip: {
|
|
93
|
+
background: "var(--ui-tip-background)",
|
|
94
|
+
borderColor: "var(--ui-tip-border)",
|
|
95
|
+
color: "var(--ui-tip-text)"
|
|
96
|
+
},
|
|
97
|
+
warning: {
|
|
98
|
+
background: "var(--ui-warning-background)",
|
|
99
|
+
borderColor: "var(--ui-warning-border)",
|
|
100
|
+
color: "var(--ui-warning-text)"
|
|
101
|
+
},
|
|
102
|
+
danger: {
|
|
103
|
+
background: "var(--ui-danger-background)",
|
|
104
|
+
borderColor: "var(--ui-danger-border)",
|
|
105
|
+
color: "var(--ui-danger-text)"
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
name: "Breadcrumb",
|
|
111
|
+
enabled: true,
|
|
112
|
+
defaults: {
|
|
113
|
+
separator: "/",
|
|
114
|
+
showHome: true,
|
|
115
|
+
maxItems: 5
|
|
116
|
+
},
|
|
117
|
+
styles: {
|
|
118
|
+
fontSize: "var(--ui-text-sm)",
|
|
119
|
+
color: "var(--ui-text-secondary)",
|
|
120
|
+
padding: "var(--ui-space-2) 0"
|
|
121
|
+
},
|
|
122
|
+
variants: {
|
|
123
|
+
compact: {
|
|
124
|
+
maxItems: 3,
|
|
125
|
+
separator: ">"
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
name: "SearchModal",
|
|
131
|
+
enabled: true,
|
|
132
|
+
defaults: {
|
|
133
|
+
placeholder: "Search documentation...",
|
|
134
|
+
hotkey: "ctrl+k",
|
|
135
|
+
maxResults: 10
|
|
136
|
+
},
|
|
137
|
+
styles: {
|
|
138
|
+
background: "var(--ui-background)",
|
|
139
|
+
borderRadius: "var(--ui-radius-xl)",
|
|
140
|
+
shadow: "var(--ui-shadow-modal)",
|
|
141
|
+
padding: "var(--ui-space-6)"
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
name: "ApiReference",
|
|
146
|
+
enabled: true,
|
|
147
|
+
defaults: {
|
|
148
|
+
showTypes: true,
|
|
149
|
+
showExamples: true,
|
|
150
|
+
expandable: true
|
|
151
|
+
},
|
|
152
|
+
styles: {
|
|
153
|
+
borderRadius: "var(--ui-radius-md)",
|
|
154
|
+
border: "1px solid var(--ui-border)",
|
|
155
|
+
padding: "var(--ui-space-4)"
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
name: "Pagination",
|
|
160
|
+
enabled: true,
|
|
161
|
+
defaults: {
|
|
162
|
+
showPrevNext: true,
|
|
163
|
+
showPageNumbers: false
|
|
164
|
+
},
|
|
165
|
+
styles: {
|
|
166
|
+
padding: "var(--ui-space-8) 0",
|
|
167
|
+
borderTop: "1px solid var(--ui-border)"
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
];
|
|
171
|
+
|
|
172
|
+
export {
|
|
173
|
+
docsComponents
|
|
174
|
+
};
|
|
175
|
+
//# sourceMappingURL=chunk-QKN5WBAL.mjs.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/components.ts"],
|
|
4
|
+
"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"],
|
|
5
|
+
"mappings": ";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;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import {
|
|
2
|
+
docsTokens
|
|
3
|
+
} from "./chunk-D5ZMUFJ5.mjs";
|
|
4
|
+
import {
|
|
5
|
+
docsComponents
|
|
6
|
+
} from "./chunk-QKN5WBAL.mjs";
|
|
7
|
+
import {
|
|
8
|
+
apiReferenceLayout,
|
|
9
|
+
docsLayout,
|
|
10
|
+
fullWidthLayout,
|
|
11
|
+
searchLayout
|
|
12
|
+
} from "./chunk-NMPQAUNP.mjs";
|
|
13
|
+
|
|
14
|
+
// src/index.ts
|
|
15
|
+
var docsPreset = {
|
|
16
|
+
options: {
|
|
17
|
+
name: "docs",
|
|
18
|
+
version: "0.1.0",
|
|
19
|
+
description: "Documentation site preset with optimized readability and navigation",
|
|
20
|
+
author: "@ouraihub",
|
|
21
|
+
tags: ["documentation", "docs", "technical-writing", "api-reference"],
|
|
22
|
+
isDefault: false
|
|
23
|
+
},
|
|
24
|
+
tokens: docsTokens,
|
|
25
|
+
components: docsComponents,
|
|
26
|
+
layout: docsLayout
|
|
27
|
+
};
|
|
28
|
+
var index_default = docsPreset;
|
|
29
|
+
export {
|
|
30
|
+
apiReferenceLayout,
|
|
31
|
+
index_default as default,
|
|
32
|
+
docsComponents,
|
|
33
|
+
docsLayout,
|
|
34
|
+
docsPreset,
|
|
35
|
+
docsTokens,
|
|
36
|
+
fullWidthLayout,
|
|
37
|
+
searchLayout
|
|
38
|
+
};
|
|
39
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/index.ts"],
|
|
4
|
+
"sourcesContent": ["import type { Preset } from '@ouraihub/core/preset';\nimport { docsTokens } from './tokens';\nimport { docsComponents } from './components';\nimport { docsLayout } from './layouts';\n\n/**\n * \u6587\u6863\u7AD9\u70B9\u9884\u8BBE\u914D\u7F6E\n * \n * \u63D0\u4F9B\u5F00\u7BB1\u5373\u7528\u7684\u6587\u6863\u7AD9\u70B9\u89E3\u51B3\u65B9\u6848\uFF0C\u5305\u542B\uFF1A\n * - \u4F18\u5316\u53EF\u8BFB\u6027\u7684\u8BBE\u8BA1\u4EE4\u724C\n * - \u6587\u6863\u573A\u666F\u4E13\u7528\u7EC4\u4EF6\uFF08\u4FA7\u8FB9\u680F\u3001\u76EE\u5F55\u3001\u4EE3\u7801\u5757\u3001\u8B66\u544A\u6846\u7B49\uFF09\n * - \u54CD\u5E94\u5F0F\u5E03\u5C40\u914D\u7F6E\n * \n * @example\n * ```typescript\n * import { docsPreset } from '@ouraihub/preset-docs';\n * \n * const config = {\n * presets: [docsPreset],\n * };\n * ```\n */\nexport const docsPreset: Preset = {\n options: {\n name: 'docs',\n version: '0.1.0',\n description: 'Documentation site preset with optimized readability and navigation',\n author: '@ouraihub',\n tags: ['documentation', 'docs', 'technical-writing', 'api-reference'],\n isDefault: false,\n },\n \n tokens: docsTokens,\n components: docsComponents,\n layout: docsLayout,\n};\n\nexport { docsTokens } from './tokens';\nexport { docsComponents } from './components';\nexport { \n docsLayout, \n apiReferenceLayout, \n searchLayout, \n fullWidthLayout \n} from './layouts';\n\nexport default docsPreset;\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;AAsBO,IAAM,aAAqB;AAAA,EAChC,SAAS;AAAA,IACP,MAAM;AAAA,IACN,SAAS;AAAA,IACT,aAAa;AAAA,IACb,QAAQ;AAAA,IACR,MAAM,CAAC,iBAAiB,QAAQ,qBAAqB,eAAe;AAAA,IACpE,WAAW;AAAA,EACb;AAAA,EAEA,QAAQ;AAAA,EACR,YAAY;AAAA,EACZ,QAAQ;AACV;AAWA,IAAO,gBAAQ;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,eAAe,EA+K3C,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { Preset } from '@ouraihub/core/preset';
|
|
2
|
+
/**
|
|
3
|
+
* 文档站点预设配置
|
|
4
|
+
*
|
|
5
|
+
* 提供开箱即用的文档站点解决方案,包含:
|
|
6
|
+
* - 优化可读性的设计令牌
|
|
7
|
+
* - 文档场景专用组件(侧边栏、目录、代码块、警告框等)
|
|
8
|
+
* - 响应式布局配置
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```typescript
|
|
12
|
+
* import { docsPreset } from '@ouraihub/preset-docs';
|
|
13
|
+
*
|
|
14
|
+
* const config = {
|
|
15
|
+
* presets: [docsPreset],
|
|
16
|
+
* };
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
export declare const docsPreset: Preset;
|
|
20
|
+
export { docsTokens } from './tokens';
|
|
21
|
+
export { docsComponents } from './components';
|
|
22
|
+
export { docsLayout, apiReferenceLayout, searchLayout, fullWidthLayout } from './layouts';
|
|
23
|
+
export default docsPreset;
|
|
24
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAKpD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,EAAE,MAaxB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,eAAe,EAChB,MAAM,WAAW,CAAC;AAEnB,eAAe,UAAU,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { LayoutConfig } from '@ouraihub/core/preset';
|
|
2
|
+
/**
|
|
3
|
+
* 文档页面布局配置
|
|
4
|
+
*/
|
|
5
|
+
export declare const docsLayout: LayoutConfig;
|
|
6
|
+
/**
|
|
7
|
+
* API 参考页布局配置
|
|
8
|
+
*/
|
|
9
|
+
export declare const apiReferenceLayout: LayoutConfig;
|
|
10
|
+
/**
|
|
11
|
+
* 搜索页布局配置
|
|
12
|
+
*/
|
|
13
|
+
export declare const searchLayout: LayoutConfig;
|
|
14
|
+
/**
|
|
15
|
+
* 全宽布局配置(用于首页等)
|
|
16
|
+
*/
|
|
17
|
+
export declare const fullWidthLayout: LayoutConfig;
|
|
18
|
+
//# sourceMappingURL=layouts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"layouts.d.ts","sourceRoot":"","sources":["../../src/layouts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,YAwCxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,YA6BhC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,YAsB1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,YAmB7B,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { DesignTokens } from '@ouraihub/core/preset';
|
|
2
|
+
/**
|
|
3
|
+
* 文档站点专用设计令牌
|
|
4
|
+
*
|
|
5
|
+
* 针对文档场景优化,强调:
|
|
6
|
+
* - 可读性:更大的字体、更宽松的行高
|
|
7
|
+
* - 层次感:清晰的标题层级
|
|
8
|
+
* - 代码展示:优化的代码块样式
|
|
9
|
+
* - 导航体验:侧边栏和目录的视觉设计
|
|
10
|
+
*/
|
|
11
|
+
export declare const docsTokens: DesignTokens;
|
|
12
|
+
//# sourceMappingURL=tokens.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,EAAE,YAqJxB,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ouraihub/preset-docs",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Documentation site preset with optimized readability and navigation",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/cjs/index.cjs",
|
|
7
|
+
"module": "./dist/esm/index.mjs",
|
|
8
|
+
"types": "./dist/types/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"types": "./dist/types/index.d.ts",
|
|
12
|
+
"import": "./dist/esm/index.mjs",
|
|
13
|
+
"require": "./dist/cjs/index.cjs"
|
|
14
|
+
},
|
|
15
|
+
"./tokens": {
|
|
16
|
+
"types": "./dist/types/tokens.d.ts",
|
|
17
|
+
"import": "./dist/esm/tokens.mjs",
|
|
18
|
+
"require": "./dist/cjs/tokens.cjs"
|
|
19
|
+
},
|
|
20
|
+
"./components": {
|
|
21
|
+
"types": "./dist/types/components.d.ts",
|
|
22
|
+
"import": "./dist/esm/components.mjs",
|
|
23
|
+
"require": "./dist/cjs/components.cjs"
|
|
24
|
+
},
|
|
25
|
+
"./layouts": {
|
|
26
|
+
"types": "./dist/types/layouts.d.ts",
|
|
27
|
+
"import": "./dist/esm/layouts.mjs",
|
|
28
|
+
"require": "./dist/cjs/layouts.cjs"
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"files": [
|
|
32
|
+
"dist",
|
|
33
|
+
"README.md"
|
|
34
|
+
],
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"@ouraihub/core": "0.1.0",
|
|
37
|
+
"@ouraihub/tokens": "0.1.0"
|
|
38
|
+
},
|
|
39
|
+
"keywords": [
|
|
40
|
+
"preset",
|
|
41
|
+
"documentation",
|
|
42
|
+
"docs",
|
|
43
|
+
"technical-writing",
|
|
44
|
+
"api-reference",
|
|
45
|
+
"design-system"
|
|
46
|
+
],
|
|
47
|
+
"author": "@ouraihub",
|
|
48
|
+
"license": "MIT",
|
|
49
|
+
"devDependencies": {
|
|
50
|
+
"esbuild": "^0.28.0",
|
|
51
|
+
"typescript": "^5.9.0"
|
|
52
|
+
},
|
|
53
|
+
"publishConfig": {
|
|
54
|
+
"access": "public"
|
|
55
|
+
},
|
|
56
|
+
"scripts": {
|
|
57
|
+
"build": "node build.js && tsc --emitDeclarationOnly",
|
|
58
|
+
"dev": "node build.js --watch",
|
|
59
|
+
"test": "vitest run",
|
|
60
|
+
"test:watch": "vitest",
|
|
61
|
+
"typecheck": "tsc --noEmit",
|
|
62
|
+
"clean": "rm -rf dist"
|
|
63
|
+
}
|
|
64
|
+
}
|