@umami/shiso 0.55.0 → 0.61.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.
Files changed (99) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +9 -49
  3. package/bin/shiso.mjs +132 -0
  4. package/docs.schema.json +835 -0
  5. package/mdx.config.ts +143 -0
  6. package/package.json +73 -83
  7. package/scripts/check-package.mjs +18 -0
  8. package/scripts/generate-icon-registry.mjs +196 -0
  9. package/scripts/generate-last-modified.mjs +128 -0
  10. package/scripts/generate-search-index.mjs +252 -0
  11. package/scripts/load-docs-config.mjs +244 -0
  12. package/scripts/prerender.mjs +187 -0
  13. package/scripts/validate-config.mjs +104 -0
  14. package/scripts/vite-docs-config.mjs +60 -0
  15. package/src/App.tsx +39 -0
  16. package/src/components/Banner.tsx +69 -0
  17. package/src/components/CodeBlock.tsx +46 -0
  18. package/src/components/ConfiguredIcon.tsx +15 -0
  19. package/src/components/ContextualMenu.tsx +93 -0
  20. package/src/components/DocContent.tsx +100 -0
  21. package/src/components/Docs.tsx +126 -0
  22. package/src/components/Footer.tsx +84 -0
  23. package/src/components/Header.tsx +72 -0
  24. package/src/components/Layout.tsx +16 -0
  25. package/src/components/PageLinks.tsx +71 -0
  26. package/src/components/Search.tsx +208 -0
  27. package/src/components/SideNav.tsx +347 -0
  28. package/src/components/SocialIcon.tsx +88 -0
  29. package/src/components/ThemeToggle.tsx +34 -0
  30. package/src/components/TopNav.tsx +127 -0
  31. package/src/components/docs/Accordion.tsx +68 -0
  32. package/src/components/docs/Badge.tsx +171 -0
  33. package/src/components/docs/Callout.tsx +73 -0
  34. package/src/components/docs/Card.tsx +158 -0
  35. package/src/components/docs/CodeGroup.tsx +73 -0
  36. package/src/components/docs/Columns.tsx +20 -0
  37. package/src/components/docs/Expandable.tsx +28 -0
  38. package/src/components/docs/Frame.tsx +56 -0
  39. package/src/components/docs/Icon.tsx +30 -0
  40. package/src/components/docs/ParamField.tsx +45 -0
  41. package/src/components/docs/PropertiesTable.tsx +84 -0
  42. package/src/components/docs/ResponseField.tsx +36 -0
  43. package/src/components/docs/Steps.tsx +47 -0
  44. package/src/components/docs/Tabs.tsx +116 -0
  45. package/src/components/docs/Tooltip.tsx +21 -0
  46. package/src/components/docs/index.ts +15 -0
  47. package/src/components/docs/styles.ts +82 -0
  48. package/src/components/docs/utils.ts +118 -0
  49. package/src/components/icons/index.ts +17 -0
  50. package/src/components/ui/accordion.tsx +69 -0
  51. package/src/components/ui/alert.tsx +69 -0
  52. package/src/components/ui/badge.tsx +49 -0
  53. package/src/components/ui/button.tsx +58 -0
  54. package/src/components/ui/card.tsx +88 -0
  55. package/src/components/ui/collapsible.tsx +15 -0
  56. package/src/components/ui/command.tsx +173 -0
  57. package/src/components/ui/dialog.tsx +137 -0
  58. package/src/components/ui/dropdown-menu.tsx +257 -0
  59. package/src/components/ui/scroll-area.tsx +71 -0
  60. package/src/components/ui/sheet.tsx +124 -0
  61. package/src/components/ui/tabs.tsx +73 -0
  62. package/src/components/ui/tooltip.tsx +52 -0
  63. package/src/declarations.d.ts +9 -0
  64. package/src/entry-client.tsx +17 -0
  65. package/src/entry-server.tsx +77 -0
  66. package/src/generated/last-modified.ts +2 -0
  67. package/src/lib/content.ts +44 -0
  68. package/src/lib/docs-config.ts +682 -0
  69. package/src/lib/head.ts +220 -0
  70. package/src/lib/icon-registry.generated.ts +4 -0
  71. package/src/lib/icons.ts +29 -0
  72. package/src/lib/inline-markdown.tsx +86 -0
  73. package/src/lib/mdast.ts +56 -0
  74. package/src/lib/paths.ts +86 -0
  75. package/src/lib/remark-toc.ts +71 -0
  76. package/src/lib/search/config.ts +43 -0
  77. package/src/lib/search/provider.ts +80 -0
  78. package/src/lib/search/providers/local.ts +15 -0
  79. package/src/lib/search-index.generated.ts +4 -0
  80. package/src/lib/search.ts +100 -0
  81. package/src/lib/site-config.ts +104 -0
  82. package/src/lib/site-model.ts +221 -0
  83. package/src/lib/slug.ts +38 -0
  84. package/src/lib/types.ts +478 -0
  85. package/src/lib/utils.ts +6 -0
  86. package/src/pages/DocPage.tsx +33 -0
  87. package/src/styles/global.css +268 -0
  88. package/src/styles/tokens.css +114 -0
  89. package/types/client.d.ts +3 -0
  90. package/types/search.d.ts +17 -0
  91. package/vite.config.ts +342 -0
  92. package/LICENSE +0 -21
  93. package/dist/index.css +0 -189
  94. package/dist/index.d.ts +0 -57
  95. package/dist/index.js +0 -464
  96. package/dist/index.mjs +0 -437
  97. package/server/index.d.ts +0 -30
  98. package/server/index.js +0 -189
  99. package/styles.css +0 -4766
@@ -0,0 +1,268 @@
1
+ @import "tailwindcss";
2
+ @import "tw-animate-css";
3
+ @import "./tokens.css";
4
+ @source "../";
5
+
6
+ @custom-variant dark (&:where([data-theme="dark"], [data-theme="dark"] *));
7
+
8
+ @layer base {
9
+ *,
10
+ *::before,
11
+ *::after {
12
+ box-sizing: border-box;
13
+ }
14
+
15
+ * {
16
+ margin: 0;
17
+ padding: 0;
18
+ border-color: var(--border);
19
+ outline-color: color-mix(in srgb, var(--ring) 50%, transparent);
20
+ }
21
+
22
+ html,
23
+ body {
24
+ font-family: var(--font-sans);
25
+ font-weight: var(--font-body-weight, 400);
26
+ color: var(--foreground);
27
+ background-color: var(--background);
28
+ scrollbar-gutter: stable;
29
+ -webkit-font-smoothing: antialiased;
30
+ }
31
+
32
+ img,
33
+ video,
34
+ svg {
35
+ max-width: 100%;
36
+ display: block;
37
+ }
38
+
39
+ button {
40
+ font: inherit;
41
+ color: inherit;
42
+ background: none;
43
+ border: none;
44
+ cursor: pointer;
45
+ }
46
+
47
+ a,
48
+ a:active,
49
+ a:hover {
50
+ color: inherit;
51
+ text-decoration: none;
52
+ }
53
+
54
+ code,
55
+ pre {
56
+ font-family: var(--font-mono);
57
+ }
58
+ }
59
+
60
+ /* Markdown content */
61
+
62
+ @layer components {
63
+ .docs-markdown {
64
+ margin-bottom: 2.5rem;
65
+ font-size: 16px;
66
+ line-height: 1.75;
67
+ }
68
+
69
+ .docs-markdown > * + * {
70
+ margin-top: 1rem;
71
+ }
72
+
73
+ .docs-markdown :where(h2, h3, h4, h5, h6) {
74
+ font-family: var(--font-heading);
75
+ font-weight: var(--font-heading-weight, 700);
76
+ letter-spacing: -0.02em;
77
+ line-height: 1.25;
78
+ color: var(--foreground);
79
+ scroll-margin-top: 1rem;
80
+ }
81
+
82
+ /* Permalink appended to every heading by rehype-autolink-headings.
83
+ Hidden until the heading is hovered, or the link itself is focused. */
84
+ .docs-markdown .heading-anchor {
85
+ margin-left: 0.4rem;
86
+ font-weight: 400;
87
+ color: var(--muted-foreground);
88
+ text-decoration: none;
89
+ opacity: 0;
90
+ transition: opacity 0.12s ease;
91
+ }
92
+
93
+ .docs-markdown :where(h1, h2, h3, h4, h5, h6):hover .heading-anchor,
94
+ .docs-markdown .heading-anchor:focus-visible {
95
+ opacity: 1;
96
+ }
97
+
98
+ .docs-markdown h2 {
99
+ margin-top: 2.25rem;
100
+ margin-bottom: 1rem;
101
+ font-size: 1.5rem;
102
+ }
103
+
104
+ .docs-markdown h3 {
105
+ margin-top: 1.75rem;
106
+ margin-bottom: 0.75rem;
107
+ font-size: 1.2rem;
108
+ }
109
+
110
+ .docs-markdown p {
111
+ margin: 0.75rem 0;
112
+ }
113
+
114
+ .docs-markdown ul,
115
+ .docs-markdown ol {
116
+ margin: 0.75rem 0;
117
+ padding-left: 1.25rem;
118
+ }
119
+
120
+ .docs-markdown ul {
121
+ list-style: disc;
122
+ }
123
+
124
+ .docs-markdown ol {
125
+ list-style: decimal;
126
+ }
127
+
128
+ .docs-markdown li {
129
+ margin: 0.35rem 0;
130
+ }
131
+
132
+ .docs-markdown a {
133
+ text-decoration: underline;
134
+ text-decoration-color: color-mix(in srgb, currentColor 30%, transparent);
135
+ text-underline-offset: 0.2em;
136
+ }
137
+
138
+ .docs-markdown a:hover {
139
+ text-decoration-color: currentColor;
140
+ }
141
+
142
+ .docs-markdown code:not(pre code) {
143
+ border-radius: var(--radius-sm);
144
+ background: color-mix(in srgb, currentColor 4%, transparent);
145
+ padding: 0.1rem 0.3rem;
146
+ font-size: 0.875rem;
147
+ }
148
+
149
+ .docs-markdown table {
150
+ width: 100%;
151
+ border-collapse: collapse;
152
+ margin: 1rem 0;
153
+ }
154
+
155
+ .docs-markdown th,
156
+ .docs-markdown td {
157
+ border: 1px solid var(--border);
158
+ padding: 0.5rem 0.75rem;
159
+ text-align: left;
160
+ }
161
+
162
+ .docs-markdown th {
163
+ background: var(--card);
164
+ font-weight: 600;
165
+ }
166
+
167
+ .docs-markdown table code:not(pre code) {
168
+ font-size: 0.75rem;
169
+ }
170
+
171
+ .docs-markdown blockquote {
172
+ border-left: 3px solid var(--input);
173
+ padding-left: 1rem;
174
+ color: var(--muted-foreground);
175
+ }
176
+
177
+ .docs-markdown hr {
178
+ border: none;
179
+ border-top: 1px solid var(--border);
180
+ margin: 2rem 0;
181
+ }
182
+ }
183
+
184
+ /* These rules are unlayered so they can override Highlight.js's unlayered theme. */
185
+
186
+ code.hljs {
187
+ background: transparent;
188
+ }
189
+
190
+ /* The scroll area owns code-block overflow and padding. */
191
+ pre.code-block code.hljs {
192
+ overflow: visible;
193
+ padding: 0;
194
+ }
195
+
196
+ /* GitHub Dark syntax colors, scoped so the default GitHub theme stays light. */
197
+ [data-theme="dark"] .hljs {
198
+ color: #c9d1d9;
199
+ }
200
+
201
+ [data-theme="dark"]
202
+ :is(
203
+ .hljs-doctag,
204
+ .hljs-keyword,
205
+ .hljs-meta .hljs-keyword,
206
+ .hljs-template-tag,
207
+ .hljs-template-variable,
208
+ .hljs-type,
209
+ .hljs-variable.language_
210
+ ) {
211
+ color: #ff7b72;
212
+ }
213
+
214
+ [data-theme="dark"]
215
+ :is(.hljs-title, .hljs-title.class_, .hljs-title.class_.inherited__, .hljs-title.function_) {
216
+ color: #d2a8ff;
217
+ }
218
+
219
+ [data-theme="dark"]
220
+ :is(
221
+ .hljs-attr,
222
+ .hljs-attribute,
223
+ .hljs-literal,
224
+ .hljs-meta,
225
+ .hljs-number,
226
+ .hljs-operator,
227
+ .hljs-variable,
228
+ .hljs-selector-attr,
229
+ .hljs-selector-class,
230
+ .hljs-selector-id,
231
+ .hljs-section
232
+ ) {
233
+ color: #79c0ff;
234
+ }
235
+
236
+ [data-theme="dark"] :is(.hljs-regexp, .hljs-string, .hljs-meta .hljs-string) {
237
+ color: #a5d6ff;
238
+ }
239
+
240
+ [data-theme="dark"] :is(.hljs-built_in, .hljs-symbol) {
241
+ color: #ffa657;
242
+ }
243
+
244
+ [data-theme="dark"] :is(.hljs-comment, .hljs-code, .hljs-formula) {
245
+ color: #8b949e;
246
+ }
247
+
248
+ [data-theme="dark"] :is(.hljs-name, .hljs-quote, .hljs-selector-tag, .hljs-selector-pseudo) {
249
+ color: #7ee787;
250
+ }
251
+
252
+ [data-theme="dark"] :is(.hljs-subst, .hljs-emphasis, .hljs-strong) {
253
+ color: #c9d1d9;
254
+ }
255
+
256
+ [data-theme="dark"] .hljs-bullet {
257
+ color: #f2cc60;
258
+ }
259
+
260
+ [data-theme="dark"] .hljs-addition {
261
+ color: #aff5b4;
262
+ background-color: #033a16;
263
+ }
264
+
265
+ [data-theme="dark"] .hljs-deletion {
266
+ color: #ffdcd7;
267
+ background-color: #67060c;
268
+ }
@@ -0,0 +1,114 @@
1
+ @theme inline {
2
+ --color-background: var(--background);
3
+ --color-foreground: var(--foreground);
4
+ --color-card: var(--card);
5
+ --color-card-foreground: var(--card-foreground);
6
+ --color-popover: var(--popover);
7
+ --color-popover-foreground: var(--popover-foreground);
8
+ --color-primary: var(--primary);
9
+ --color-primary-foreground: var(--primary-foreground);
10
+ --color-secondary: var(--secondary);
11
+ --color-secondary-foreground: var(--secondary-foreground);
12
+ --color-muted: var(--muted);
13
+ --color-muted-foreground: var(--muted-foreground);
14
+ --color-accent: var(--accent);
15
+ --color-accent-foreground: var(--accent-foreground);
16
+ --color-destructive: var(--destructive);
17
+ --color-border: var(--border);
18
+ --color-input: var(--input);
19
+ --color-ring: var(--ring);
20
+ --color-chart-1: var(--chart-1);
21
+ --color-chart-2: var(--chart-2);
22
+ --color-chart-3: var(--chart-3);
23
+ --color-chart-4: var(--chart-4);
24
+ --color-chart-5: var(--chart-5);
25
+ --color-sidebar: var(--sidebar);
26
+ --color-sidebar-foreground: var(--sidebar-foreground);
27
+ --color-sidebar-primary: var(--sidebar-primary);
28
+ --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
29
+ --color-sidebar-accent: var(--sidebar-accent);
30
+ --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
31
+ --color-sidebar-border: var(--sidebar-border);
32
+ --color-sidebar-ring: var(--sidebar-ring);
33
+ --radius-sm: calc(var(--radius) * 0.6);
34
+ --radius-md: calc(var(--radius) * 0.8);
35
+ --radius-lg: var(--radius);
36
+ --radius-xl: calc(var(--radius) * 1.4);
37
+ --radius-2xl: calc(var(--radius) * 1.8);
38
+ --radius-3xl: calc(var(--radius) * 2.2);
39
+ --radius-4xl: calc(var(--radius) * 2.6);
40
+ }
41
+
42
+ :root {
43
+ --font-sans: "Inter", system-ui, -apple-system, "Segoe UI", sans-serif;
44
+ --font-mono: "JetBrains Mono", ui-monospace, "SF Mono", Menlo, monospace;
45
+ --font-heading: var(--font-sans);
46
+ --header-height: 3rem;
47
+ --radius: 0.625rem;
48
+
49
+ --background: #ffffff;
50
+ --foreground: #111827;
51
+ --card: #fafafa;
52
+ --card-foreground: #111827;
53
+ --popover: #ffffff;
54
+ --popover-foreground: #111827;
55
+ --primary: #16a34a;
56
+ --primary-foreground: #ffffff;
57
+ --secondary: #f4f4f5;
58
+ --secondary-foreground: #18181b;
59
+ --muted: #f4f4f5;
60
+ --muted-foreground: #71717a;
61
+ --accent: #f4f4f5;
62
+ --accent-foreground: #18181b;
63
+ --destructive: #dc2626;
64
+ --border: #e4e4e7;
65
+ --input: #d4d4d8;
66
+ --ring: #16a34a;
67
+ --chart-1: #16a34a;
68
+ --chart-2: #2563eb;
69
+ --chart-3: #9333ea;
70
+ --chart-4: #d97706;
71
+ --chart-5: #dc2626;
72
+ --sidebar: #fafafa;
73
+ --sidebar-foreground: #111827;
74
+ --sidebar-primary: #16a34a;
75
+ --sidebar-primary-foreground: #ffffff;
76
+ --sidebar-accent: #f4f4f5;
77
+ --sidebar-accent-foreground: #18181b;
78
+ --sidebar-border: #e4e4e7;
79
+ --sidebar-ring: #16a34a;
80
+ }
81
+
82
+ [data-theme="dark"] {
83
+ --background: #101014;
84
+ --foreground: #fafafa;
85
+ --card: #18181c;
86
+ --card-foreground: #fafafa;
87
+ --popover: #18181c;
88
+ --popover-foreground: #fafafa;
89
+ --primary: #16a34a;
90
+ --primary-foreground: #ffffff;
91
+ --secondary: #1e1e23;
92
+ --secondary-foreground: #fafafa;
93
+ --muted: #1e1e23;
94
+ --muted-foreground: #8b8b94;
95
+ --accent: #1e1e23;
96
+ --accent-foreground: #fafafa;
97
+ --destructive: #f87171;
98
+ --border: #2b2b31;
99
+ --input: #3f3f46;
100
+ --ring: #22c55e;
101
+ --chart-1: #4ade80;
102
+ --chart-2: #60a5fa;
103
+ --chart-3: #c084fc;
104
+ --chart-4: #fbbf24;
105
+ --chart-5: #f87171;
106
+ --sidebar: #18181c;
107
+ --sidebar-foreground: #fafafa;
108
+ --sidebar-primary: #22c55e;
109
+ --sidebar-primary-foreground: #ffffff;
110
+ --sidebar-accent: #1e1e23;
111
+ --sidebar-accent-foreground: #fafafa;
112
+ --sidebar-border: #2b2b31;
113
+ --sidebar-ring: #22c55e;
114
+ }
@@ -0,0 +1,3 @@
1
+ import type { Root } from 'react-dom/client';
2
+
3
+ export function mount(element?: HTMLElement | null): Root;
@@ -0,0 +1,17 @@
1
+ export interface SearchResult {
2
+ url: string;
3
+ page: string;
4
+ score: number;
5
+ heading?: string;
6
+ snippet?: string;
7
+ }
8
+
9
+ export interface SearchProvider {
10
+ search(query: string, limit?: number): Promise<SearchResult[]>;
11
+ }
12
+
13
+ export type SearchProviderFactory = (
14
+ options: Record<string, unknown>,
15
+ ) => SearchProvider | Promise<SearchProvider>;
16
+
17
+ export function registerSearchProvider(id: string, factory: SearchProviderFactory): () => void;