@vendure-io/docs-provider 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/README.md +245 -0
- package/dist/frontmatter.d.ts +89 -0
- package/dist/frontmatter.d.ts.map +1 -0
- package/dist/index.cjs +1 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +36 -0
- package/dist/loader.cjs +1 -0
- package/dist/loader.d.ts +99 -0
- package/dist/loader.d.ts.map +1 -0
- package/dist/loader.js +90 -0
- package/dist/manifest-B1CxKK1i.js +207 -0
- package/dist/manifest-D2yANQB-.cjs +3 -0
- package/dist/manifest.d.ts +127 -0
- package/dist/manifest.d.ts.map +1 -0
- package/dist/navigation-utils.d.ts +15 -0
- package/dist/navigation-utils.d.ts.map +1 -0
- package/dist/schema.d.ts +419 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/types.d.ts +116 -0
- package/dist/types.d.ts.map +1 -0
- package/docs/creating-a-docs-package.md +394 -0
- package/docs/frontmatter-reference.md +364 -0
- package/docs/getting-started.md +156 -0
- package/docs/manifest-reference.md +520 -0
- package/docs/publishing.md +352 -0
- package/package.json +76 -0
package/dist/schema.d.ts
ADDED
|
@@ -0,0 +1,419 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Schema for supported Vendure versions
|
|
4
|
+
*/
|
|
5
|
+
export declare const VendureVersionSchema: z.ZodEnum<["v1", "v2", "v3"]>;
|
|
6
|
+
/**
|
|
7
|
+
* Schema for search configuration
|
|
8
|
+
*/
|
|
9
|
+
export declare const SearchConfigSchema: z.ZodObject<{
|
|
10
|
+
indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
|
|
11
|
+
boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
|
|
12
|
+
}, "strip", z.ZodTypeAny, {
|
|
13
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
14
|
+
boosts?: Record<string, number> | undefined;
|
|
15
|
+
}, {
|
|
16
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
17
|
+
boosts?: Record<string, number> | undefined;
|
|
18
|
+
}>;
|
|
19
|
+
/**
|
|
20
|
+
* Schema for GitHub repository configuration
|
|
21
|
+
*/
|
|
22
|
+
export declare const GitHubConfigSchema: z.ZodObject<{
|
|
23
|
+
repository: z.ZodString;
|
|
24
|
+
branch: z.ZodOptional<z.ZodString>;
|
|
25
|
+
docsPath: z.ZodOptional<z.ZodString>;
|
|
26
|
+
}, "strip", z.ZodTypeAny, {
|
|
27
|
+
repository: string;
|
|
28
|
+
branch?: string | undefined;
|
|
29
|
+
docsPath?: string | undefined;
|
|
30
|
+
}, {
|
|
31
|
+
repository: string;
|
|
32
|
+
branch?: string | undefined;
|
|
33
|
+
docsPath?: string | undefined;
|
|
34
|
+
}>;
|
|
35
|
+
/**
|
|
36
|
+
* Schema for navigation nodes (recursive)
|
|
37
|
+
*/
|
|
38
|
+
export declare const NavigationNodeSchema: z.ZodType<{
|
|
39
|
+
title: string;
|
|
40
|
+
slug: string;
|
|
41
|
+
file?: string;
|
|
42
|
+
children?: unknown[];
|
|
43
|
+
badge?: string;
|
|
44
|
+
}>;
|
|
45
|
+
/**
|
|
46
|
+
* Schema for documentation package manifest
|
|
47
|
+
*/
|
|
48
|
+
export declare const DocsPackageManifestSchema: z.ZodObject<{
|
|
49
|
+
id: z.ZodString;
|
|
50
|
+
name: z.ZodString;
|
|
51
|
+
version: z.ZodString;
|
|
52
|
+
vendureVersion: z.ZodEnum<["v1", "v2", "v3"]>;
|
|
53
|
+
navigation: z.ZodArray<z.ZodType<{
|
|
54
|
+
title: string;
|
|
55
|
+
slug: string;
|
|
56
|
+
file?: string;
|
|
57
|
+
children?: unknown[];
|
|
58
|
+
badge?: string;
|
|
59
|
+
}, z.ZodTypeDef, {
|
|
60
|
+
title: string;
|
|
61
|
+
slug: string;
|
|
62
|
+
file?: string;
|
|
63
|
+
children?: unknown[];
|
|
64
|
+
badge?: string;
|
|
65
|
+
}>, "many">;
|
|
66
|
+
search: z.ZodOptional<z.ZodObject<{
|
|
67
|
+
indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
|
|
68
|
+
boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
|
|
69
|
+
}, "strip", z.ZodTypeAny, {
|
|
70
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
71
|
+
boosts?: Record<string, number> | undefined;
|
|
72
|
+
}, {
|
|
73
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
74
|
+
boosts?: Record<string, number> | undefined;
|
|
75
|
+
}>>;
|
|
76
|
+
github: z.ZodOptional<z.ZodObject<{
|
|
77
|
+
repository: z.ZodString;
|
|
78
|
+
branch: z.ZodOptional<z.ZodString>;
|
|
79
|
+
docsPath: z.ZodOptional<z.ZodString>;
|
|
80
|
+
}, "strip", z.ZodTypeAny, {
|
|
81
|
+
repository: string;
|
|
82
|
+
branch?: string | undefined;
|
|
83
|
+
docsPath?: string | undefined;
|
|
84
|
+
}, {
|
|
85
|
+
repository: string;
|
|
86
|
+
branch?: string | undefined;
|
|
87
|
+
docsPath?: string | undefined;
|
|
88
|
+
}>>;
|
|
89
|
+
}, "strip", z.ZodTypeAny, {
|
|
90
|
+
id: string;
|
|
91
|
+
name: string;
|
|
92
|
+
version: string;
|
|
93
|
+
vendureVersion: "v1" | "v2" | "v3";
|
|
94
|
+
navigation: {
|
|
95
|
+
title: string;
|
|
96
|
+
slug: string;
|
|
97
|
+
file?: string;
|
|
98
|
+
children?: unknown[];
|
|
99
|
+
badge?: string;
|
|
100
|
+
}[];
|
|
101
|
+
search?: {
|
|
102
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
103
|
+
boosts?: Record<string, number> | undefined;
|
|
104
|
+
} | undefined;
|
|
105
|
+
github?: {
|
|
106
|
+
repository: string;
|
|
107
|
+
branch?: string | undefined;
|
|
108
|
+
docsPath?: string | undefined;
|
|
109
|
+
} | undefined;
|
|
110
|
+
}, {
|
|
111
|
+
id: string;
|
|
112
|
+
name: string;
|
|
113
|
+
version: string;
|
|
114
|
+
vendureVersion: "v1" | "v2" | "v3";
|
|
115
|
+
navigation: {
|
|
116
|
+
title: string;
|
|
117
|
+
slug: string;
|
|
118
|
+
file?: string;
|
|
119
|
+
children?: unknown[];
|
|
120
|
+
badge?: string;
|
|
121
|
+
}[];
|
|
122
|
+
search?: {
|
|
123
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
124
|
+
boosts?: Record<string, number> | undefined;
|
|
125
|
+
} | undefined;
|
|
126
|
+
github?: {
|
|
127
|
+
repository: string;
|
|
128
|
+
branch?: string | undefined;
|
|
129
|
+
docsPath?: string | undefined;
|
|
130
|
+
} | undefined;
|
|
131
|
+
}>;
|
|
132
|
+
/**
|
|
133
|
+
* Schema for documentation page frontmatter/metadata
|
|
134
|
+
*/
|
|
135
|
+
export declare const DocPageMetaSchema: z.ZodObject<{
|
|
136
|
+
title: z.ZodString;
|
|
137
|
+
description: z.ZodOptional<z.ZodString>;
|
|
138
|
+
keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
139
|
+
sidebarLabel: z.ZodOptional<z.ZodString>;
|
|
140
|
+
hidden: z.ZodOptional<z.ZodBoolean>;
|
|
141
|
+
}, "strip", z.ZodTypeAny, {
|
|
142
|
+
title: string;
|
|
143
|
+
description?: string | undefined;
|
|
144
|
+
keywords?: string[] | undefined;
|
|
145
|
+
sidebarLabel?: string | undefined;
|
|
146
|
+
hidden?: boolean | undefined;
|
|
147
|
+
}, {
|
|
148
|
+
title: string;
|
|
149
|
+
description?: string | undefined;
|
|
150
|
+
keywords?: string[] | undefined;
|
|
151
|
+
sidebarLabel?: string | undefined;
|
|
152
|
+
hidden?: boolean | undefined;
|
|
153
|
+
}>;
|
|
154
|
+
/**
|
|
155
|
+
* Schema for a loaded documentation page
|
|
156
|
+
*/
|
|
157
|
+
export declare const DocPageSchema: z.ZodObject<{
|
|
158
|
+
meta: z.ZodObject<{
|
|
159
|
+
title: z.ZodString;
|
|
160
|
+
description: z.ZodOptional<z.ZodString>;
|
|
161
|
+
keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
162
|
+
sidebarLabel: z.ZodOptional<z.ZodString>;
|
|
163
|
+
hidden: z.ZodOptional<z.ZodBoolean>;
|
|
164
|
+
}, "strip", z.ZodTypeAny, {
|
|
165
|
+
title: string;
|
|
166
|
+
description?: string | undefined;
|
|
167
|
+
keywords?: string[] | undefined;
|
|
168
|
+
sidebarLabel?: string | undefined;
|
|
169
|
+
hidden?: boolean | undefined;
|
|
170
|
+
}, {
|
|
171
|
+
title: string;
|
|
172
|
+
description?: string | undefined;
|
|
173
|
+
keywords?: string[] | undefined;
|
|
174
|
+
sidebarLabel?: string | undefined;
|
|
175
|
+
hidden?: boolean | undefined;
|
|
176
|
+
}>;
|
|
177
|
+
content: z.ZodString;
|
|
178
|
+
filePath: z.ZodString;
|
|
179
|
+
}, "strip", z.ZodTypeAny, {
|
|
180
|
+
content: string;
|
|
181
|
+
meta: {
|
|
182
|
+
title: string;
|
|
183
|
+
description?: string | undefined;
|
|
184
|
+
keywords?: string[] | undefined;
|
|
185
|
+
sidebarLabel?: string | undefined;
|
|
186
|
+
hidden?: boolean | undefined;
|
|
187
|
+
};
|
|
188
|
+
filePath: string;
|
|
189
|
+
}, {
|
|
190
|
+
content: string;
|
|
191
|
+
meta: {
|
|
192
|
+
title: string;
|
|
193
|
+
description?: string | undefined;
|
|
194
|
+
keywords?: string[] | undefined;
|
|
195
|
+
sidebarLabel?: string | undefined;
|
|
196
|
+
hidden?: boolean | undefined;
|
|
197
|
+
};
|
|
198
|
+
filePath: string;
|
|
199
|
+
}>;
|
|
200
|
+
/**
|
|
201
|
+
* Schema for loaded docs package result
|
|
202
|
+
*/
|
|
203
|
+
export declare const LoadedDocsPackageSchema: z.ZodObject<{
|
|
204
|
+
manifest: z.ZodObject<{
|
|
205
|
+
id: z.ZodString;
|
|
206
|
+
name: z.ZodString;
|
|
207
|
+
version: z.ZodString;
|
|
208
|
+
vendureVersion: z.ZodEnum<["v1", "v2", "v3"]>;
|
|
209
|
+
navigation: z.ZodArray<z.ZodType<{
|
|
210
|
+
title: string;
|
|
211
|
+
slug: string;
|
|
212
|
+
file?: string;
|
|
213
|
+
children?: unknown[];
|
|
214
|
+
badge?: string;
|
|
215
|
+
}, z.ZodTypeDef, {
|
|
216
|
+
title: string;
|
|
217
|
+
slug: string;
|
|
218
|
+
file?: string;
|
|
219
|
+
children?: unknown[];
|
|
220
|
+
badge?: string;
|
|
221
|
+
}>, "many">;
|
|
222
|
+
search: z.ZodOptional<z.ZodObject<{
|
|
223
|
+
indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
|
|
224
|
+
boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
|
|
225
|
+
}, "strip", z.ZodTypeAny, {
|
|
226
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
227
|
+
boosts?: Record<string, number> | undefined;
|
|
228
|
+
}, {
|
|
229
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
230
|
+
boosts?: Record<string, number> | undefined;
|
|
231
|
+
}>>;
|
|
232
|
+
github: z.ZodOptional<z.ZodObject<{
|
|
233
|
+
repository: z.ZodString;
|
|
234
|
+
branch: z.ZodOptional<z.ZodString>;
|
|
235
|
+
docsPath: z.ZodOptional<z.ZodString>;
|
|
236
|
+
}, "strip", z.ZodTypeAny, {
|
|
237
|
+
repository: string;
|
|
238
|
+
branch?: string | undefined;
|
|
239
|
+
docsPath?: string | undefined;
|
|
240
|
+
}, {
|
|
241
|
+
repository: string;
|
|
242
|
+
branch?: string | undefined;
|
|
243
|
+
docsPath?: string | undefined;
|
|
244
|
+
}>>;
|
|
245
|
+
}, "strip", z.ZodTypeAny, {
|
|
246
|
+
id: string;
|
|
247
|
+
name: string;
|
|
248
|
+
version: string;
|
|
249
|
+
vendureVersion: "v1" | "v2" | "v3";
|
|
250
|
+
navigation: {
|
|
251
|
+
title: string;
|
|
252
|
+
slug: string;
|
|
253
|
+
file?: string;
|
|
254
|
+
children?: unknown[];
|
|
255
|
+
badge?: string;
|
|
256
|
+
}[];
|
|
257
|
+
search?: {
|
|
258
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
259
|
+
boosts?: Record<string, number> | undefined;
|
|
260
|
+
} | undefined;
|
|
261
|
+
github?: {
|
|
262
|
+
repository: string;
|
|
263
|
+
branch?: string | undefined;
|
|
264
|
+
docsPath?: string | undefined;
|
|
265
|
+
} | undefined;
|
|
266
|
+
}, {
|
|
267
|
+
id: string;
|
|
268
|
+
name: string;
|
|
269
|
+
version: string;
|
|
270
|
+
vendureVersion: "v1" | "v2" | "v3";
|
|
271
|
+
navigation: {
|
|
272
|
+
title: string;
|
|
273
|
+
slug: string;
|
|
274
|
+
file?: string;
|
|
275
|
+
children?: unknown[];
|
|
276
|
+
badge?: string;
|
|
277
|
+
}[];
|
|
278
|
+
search?: {
|
|
279
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
280
|
+
boosts?: Record<string, number> | undefined;
|
|
281
|
+
} | undefined;
|
|
282
|
+
github?: {
|
|
283
|
+
repository: string;
|
|
284
|
+
branch?: string | undefined;
|
|
285
|
+
docsPath?: string | undefined;
|
|
286
|
+
} | undefined;
|
|
287
|
+
}>;
|
|
288
|
+
basePath: z.ZodString;
|
|
289
|
+
}, "strip", z.ZodTypeAny, {
|
|
290
|
+
manifest: {
|
|
291
|
+
id: string;
|
|
292
|
+
name: string;
|
|
293
|
+
version: string;
|
|
294
|
+
vendureVersion: "v1" | "v2" | "v3";
|
|
295
|
+
navigation: {
|
|
296
|
+
title: string;
|
|
297
|
+
slug: string;
|
|
298
|
+
file?: string;
|
|
299
|
+
children?: unknown[];
|
|
300
|
+
badge?: string;
|
|
301
|
+
}[];
|
|
302
|
+
search?: {
|
|
303
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
304
|
+
boosts?: Record<string, number> | undefined;
|
|
305
|
+
} | undefined;
|
|
306
|
+
github?: {
|
|
307
|
+
repository: string;
|
|
308
|
+
branch?: string | undefined;
|
|
309
|
+
docsPath?: string | undefined;
|
|
310
|
+
} | undefined;
|
|
311
|
+
};
|
|
312
|
+
basePath: string;
|
|
313
|
+
}, {
|
|
314
|
+
manifest: {
|
|
315
|
+
id: string;
|
|
316
|
+
name: string;
|
|
317
|
+
version: string;
|
|
318
|
+
vendureVersion: "v1" | "v2" | "v3";
|
|
319
|
+
navigation: {
|
|
320
|
+
title: string;
|
|
321
|
+
slug: string;
|
|
322
|
+
file?: string;
|
|
323
|
+
children?: unknown[];
|
|
324
|
+
badge?: string;
|
|
325
|
+
}[];
|
|
326
|
+
search?: {
|
|
327
|
+
indexFields: ("title" | "description" | "content" | "keywords")[];
|
|
328
|
+
boosts?: Record<string, number> | undefined;
|
|
329
|
+
} | undefined;
|
|
330
|
+
github?: {
|
|
331
|
+
repository: string;
|
|
332
|
+
branch?: string | undefined;
|
|
333
|
+
docsPath?: string | undefined;
|
|
334
|
+
} | undefined;
|
|
335
|
+
};
|
|
336
|
+
basePath: string;
|
|
337
|
+
}>;
|
|
338
|
+
/**
|
|
339
|
+
* Schema for breadcrumb items
|
|
340
|
+
*/
|
|
341
|
+
export declare const BreadcrumbItemSchema: z.ZodObject<{
|
|
342
|
+
title: z.ZodString;
|
|
343
|
+
slug: z.ZodString;
|
|
344
|
+
path: z.ZodString;
|
|
345
|
+
}, "strip", z.ZodTypeAny, {
|
|
346
|
+
title: string;
|
|
347
|
+
path: string;
|
|
348
|
+
slug: string;
|
|
349
|
+
}, {
|
|
350
|
+
title: string;
|
|
351
|
+
path: string;
|
|
352
|
+
slug: string;
|
|
353
|
+
}>;
|
|
354
|
+
/**
|
|
355
|
+
* Schema for flattened navigation nodes
|
|
356
|
+
*/
|
|
357
|
+
export declare const FlatNavigationNodeSchema: z.ZodObject<{
|
|
358
|
+
title: z.ZodString;
|
|
359
|
+
slug: z.ZodString;
|
|
360
|
+
file: z.ZodOptional<z.ZodString>;
|
|
361
|
+
children: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodType<{
|
|
362
|
+
title: string;
|
|
363
|
+
slug: string;
|
|
364
|
+
file?: string;
|
|
365
|
+
children?: unknown[];
|
|
366
|
+
badge?: string;
|
|
367
|
+
}, z.ZodTypeDef, {
|
|
368
|
+
title: string;
|
|
369
|
+
slug: string;
|
|
370
|
+
file?: string;
|
|
371
|
+
children?: unknown[];
|
|
372
|
+
badge?: string;
|
|
373
|
+
}>>, "many">>;
|
|
374
|
+
badge: z.ZodOptional<z.ZodString>;
|
|
375
|
+
path: z.ZodString;
|
|
376
|
+
depth: z.ZodNumber;
|
|
377
|
+
parentPath: z.ZodOptional<z.ZodString>;
|
|
378
|
+
}, "strip", z.ZodTypeAny, {
|
|
379
|
+
title: string;
|
|
380
|
+
path: string;
|
|
381
|
+
slug: string;
|
|
382
|
+
depth: number;
|
|
383
|
+
file?: string | undefined;
|
|
384
|
+
children?: {
|
|
385
|
+
title: string;
|
|
386
|
+
slug: string;
|
|
387
|
+
file?: string;
|
|
388
|
+
children?: unknown[];
|
|
389
|
+
badge?: string;
|
|
390
|
+
}[] | undefined;
|
|
391
|
+
badge?: string | undefined;
|
|
392
|
+
parentPath?: string | undefined;
|
|
393
|
+
}, {
|
|
394
|
+
title: string;
|
|
395
|
+
path: string;
|
|
396
|
+
slug: string;
|
|
397
|
+
depth: number;
|
|
398
|
+
file?: string | undefined;
|
|
399
|
+
children?: {
|
|
400
|
+
title: string;
|
|
401
|
+
slug: string;
|
|
402
|
+
file?: string;
|
|
403
|
+
children?: unknown[];
|
|
404
|
+
badge?: string;
|
|
405
|
+
}[] | undefined;
|
|
406
|
+
badge?: string | undefined;
|
|
407
|
+
parentPath?: string | undefined;
|
|
408
|
+
}>;
|
|
409
|
+
export type VendureVersionInferred = z.infer<typeof VendureVersionSchema>;
|
|
410
|
+
export type SearchConfigInferred = z.infer<typeof SearchConfigSchema>;
|
|
411
|
+
export type GitHubConfigInferred = z.infer<typeof GitHubConfigSchema>;
|
|
412
|
+
export type NavigationNodeInferred = z.infer<typeof NavigationNodeSchema>;
|
|
413
|
+
export type DocsPackageManifestInferred = z.infer<typeof DocsPackageManifestSchema>;
|
|
414
|
+
export type DocPageMetaInferred = z.infer<typeof DocPageMetaSchema>;
|
|
415
|
+
export type DocPageInferred = z.infer<typeof DocPageSchema>;
|
|
416
|
+
export type LoadedDocsPackageInferred = z.infer<typeof LoadedDocsPackageSchema>;
|
|
417
|
+
export type BreadcrumbItemInferred = z.infer<typeof BreadcrumbItemSchema>;
|
|
418
|
+
export type FlatNavigationNodeInferred = z.infer<typeof FlatNavigationNodeSchema>;
|
|
419
|
+
//# sourceMappingURL=schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB,+BAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAQA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;eAlB7B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;EAsBd,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;EAM5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIxB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;mBAnD3B,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;EAkDd,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;eApE5B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;EAyEd,CAAA;AAGF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC/E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Supported Vendure versions for documentation targeting
|
|
3
|
+
*/
|
|
4
|
+
export type VendureVersion = 'v1' | 'v2' | 'v3';
|
|
5
|
+
/**
|
|
6
|
+
* Search indexing configuration for a documentation package
|
|
7
|
+
*/
|
|
8
|
+
export interface SearchConfig {
|
|
9
|
+
/** Fields to include in search index */
|
|
10
|
+
indexFields: ('title' | 'description' | 'content' | 'keywords')[];
|
|
11
|
+
/** Custom boost weights for search ranking */
|
|
12
|
+
boosts?: Record<string, number>;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* GitHub repository configuration for documentation
|
|
16
|
+
*/
|
|
17
|
+
export interface GitHubConfig {
|
|
18
|
+
/** GitHub repository in format "owner/repo" */
|
|
19
|
+
repository: string;
|
|
20
|
+
/** Branch to use for edit links (defaults to "main") */
|
|
21
|
+
branch?: string;
|
|
22
|
+
/** Path prefix within the repository for documentation files */
|
|
23
|
+
docsPath?: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* A node in the documentation navigation tree
|
|
27
|
+
*/
|
|
28
|
+
export interface NavigationNode {
|
|
29
|
+
/** Display title shown in navigation */
|
|
30
|
+
title: string;
|
|
31
|
+
/** URL slug for this node */
|
|
32
|
+
slug: string;
|
|
33
|
+
/** Path to MDX file relative to package root (leaf nodes) */
|
|
34
|
+
file?: string;
|
|
35
|
+
/** Nested child navigation nodes */
|
|
36
|
+
children?: NavigationNode[];
|
|
37
|
+
/** Optional badge label (e.g., "New", "Beta", "Deprecated") */
|
|
38
|
+
badge?: string;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Manifest describing a documentation package's structure and metadata
|
|
42
|
+
*/
|
|
43
|
+
export interface DocsPackageManifest {
|
|
44
|
+
/** Unique package identifier (e.g., "core", "plugins", "enterprise") */
|
|
45
|
+
id: string;
|
|
46
|
+
/** Human-readable display name */
|
|
47
|
+
name: string;
|
|
48
|
+
/** Package version (semver) */
|
|
49
|
+
version: string;
|
|
50
|
+
/** Vendure version this documentation targets */
|
|
51
|
+
vendureVersion: VendureVersion;
|
|
52
|
+
/** Navigation structure for the package */
|
|
53
|
+
navigation: NavigationNode[];
|
|
54
|
+
/** Optional search index configuration */
|
|
55
|
+
search?: SearchConfig;
|
|
56
|
+
/** Optional GitHub repository configuration for edit links and issue reporting */
|
|
57
|
+
github?: GitHubConfig;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Frontmatter metadata for a documentation page
|
|
61
|
+
*/
|
|
62
|
+
export interface DocPageMeta {
|
|
63
|
+
/** Page title */
|
|
64
|
+
title: string;
|
|
65
|
+
/** Page description for SEO and previews */
|
|
66
|
+
description?: string;
|
|
67
|
+
/** Keywords for search indexing */
|
|
68
|
+
keywords?: string[];
|
|
69
|
+
/** Custom label for sidebar (overrides title) */
|
|
70
|
+
sidebarLabel?: string;
|
|
71
|
+
/** Hide this page from navigation/sidebar */
|
|
72
|
+
hidden?: boolean;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* A fully loaded documentation page with content and metadata
|
|
76
|
+
*/
|
|
77
|
+
export interface DocPage {
|
|
78
|
+
/** Parsed frontmatter metadata */
|
|
79
|
+
meta: DocPageMeta;
|
|
80
|
+
/** Raw MDX content (without frontmatter) */
|
|
81
|
+
content: string;
|
|
82
|
+
/** Resolved file path within the package */
|
|
83
|
+
filePath: string;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Result of loading a docs package
|
|
87
|
+
*/
|
|
88
|
+
export interface LoadedDocsPackage {
|
|
89
|
+
/** The validated manifest */
|
|
90
|
+
manifest: DocsPackageManifest;
|
|
91
|
+
/** Base path for resolving content files */
|
|
92
|
+
basePath: string;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Breadcrumb item for navigation
|
|
96
|
+
*/
|
|
97
|
+
export interface BreadcrumbItem {
|
|
98
|
+
/** Display title */
|
|
99
|
+
title: string;
|
|
100
|
+
/** URL slug */
|
|
101
|
+
slug: string;
|
|
102
|
+
/** Full path from root */
|
|
103
|
+
path: string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Flattened navigation node with full path information
|
|
107
|
+
*/
|
|
108
|
+
export interface FlatNavigationNode extends NavigationNode {
|
|
109
|
+
/** Full path from root (e.g., "getting-started/installation") */
|
|
110
|
+
path: string;
|
|
111
|
+
/** Depth level in the navigation tree (0 = root) */
|
|
112
|
+
depth: number;
|
|
113
|
+
/** Parent node's path, if any */
|
|
114
|
+
parentPath?: string;
|
|
115
|
+
}
|
|
116
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,WAAW,EAAE,CAAC,OAAO,GAAG,aAAa,GAAG,SAAS,GAAG,UAAU,CAAC,EAAE,CAAA;IACjE,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,wEAAwE;IACxE,EAAE,EAAE,MAAM,CAAA;IACV,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,cAAc,EAAE,cAAc,CAAA;IAC9B,2CAA2C;IAC3C,UAAU,EAAE,cAAc,EAAE,CAAA;IAC5B,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,kFAAkF;IAClF,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,kCAAkC;IAClC,IAAI,EAAE,WAAW,CAAA;IACjB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,eAAe;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB"}
|