@thallylabs/migrate 0.2.21 → 0.2.23
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/dist/index.d.ts +43 -0
- package/dist/index.js +729 -279
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -12,6 +12,9 @@ interface MigrationNavigationGroup {
|
|
|
12
12
|
}
|
|
13
13
|
interface MigrationNavigationTab {
|
|
14
14
|
tab: string;
|
|
15
|
+
/** Reader-facing label when `tab` includes a version for unique identity. */
|
|
16
|
+
displayLabel?: string;
|
|
17
|
+
version?: string;
|
|
15
18
|
description?: string;
|
|
16
19
|
icon?: string;
|
|
17
20
|
href?: string;
|
|
@@ -40,11 +43,16 @@ interface MigrationNavbarConfig {
|
|
|
40
43
|
label: string;
|
|
41
44
|
href: string;
|
|
42
45
|
type?: 'github';
|
|
46
|
+
button?: {
|
|
47
|
+
background: string;
|
|
48
|
+
color?: string;
|
|
49
|
+
};
|
|
43
50
|
}>;
|
|
44
51
|
/** Explicit null suppresses the starter's sample call to action. */
|
|
45
52
|
primary?: {
|
|
46
53
|
label: string;
|
|
47
54
|
href: string;
|
|
55
|
+
type?: 'github';
|
|
48
56
|
} | null;
|
|
49
57
|
/** Local public assets used until an owner uploads a brand replacement. */
|
|
50
58
|
/** Explicit null requests a text-only brand when the source has no logo. */
|
|
@@ -71,10 +79,24 @@ interface MigrationDocsConfig {
|
|
|
71
79
|
markdown?: {
|
|
72
80
|
enabled?: boolean;
|
|
73
81
|
};
|
|
82
|
+
/** Local site-authored CSS projected from a source docs site, served from public/. */
|
|
83
|
+
stylesheets?: Array<string>;
|
|
74
84
|
tabs: Array<MigrationNavigationTab>;
|
|
75
85
|
navigation?: {
|
|
76
86
|
/** How sibling documentation collections are presented to readers. */
|
|
77
87
|
display?: 'tabs' | 'dropdown';
|
|
88
|
+
versions?: Array<{
|
|
89
|
+
label: string;
|
|
90
|
+
prefix: string;
|
|
91
|
+
href: string;
|
|
92
|
+
default?: boolean;
|
|
93
|
+
hidden?: boolean;
|
|
94
|
+
}>;
|
|
95
|
+
shortcuts?: Array<{
|
|
96
|
+
label: string;
|
|
97
|
+
href: string;
|
|
98
|
+
icon?: string;
|
|
99
|
+
}>;
|
|
78
100
|
};
|
|
79
101
|
theme?: 'default' | 'maple' | 'sharp' | 'minimal';
|
|
80
102
|
appearance?: {
|
|
@@ -87,6 +109,13 @@ interface MigrationDocsConfig {
|
|
|
87
109
|
decoration?: 'none' | 'grid' | 'gradient';
|
|
88
110
|
};
|
|
89
111
|
/** Icon set for content `icon` names; Mintlify's `icons.library` carries through. */
|
|
112
|
+
contextual?: {
|
|
113
|
+
options?: Array<string>;
|
|
114
|
+
};
|
|
115
|
+
colors?: Partial<Record<'light' | 'dark', {
|
|
116
|
+
primary?: string;
|
|
117
|
+
accent?: string;
|
|
118
|
+
}>>;
|
|
90
119
|
icons?: {
|
|
91
120
|
library?: 'lucide' | 'fontawesome' | 'tabler';
|
|
92
121
|
};
|
|
@@ -99,6 +128,9 @@ interface MigrationDocsConfig {
|
|
|
99
128
|
footer?: MigrationFooterConfig;
|
|
100
129
|
seo?: {
|
|
101
130
|
indexing?: 'navigable' | 'all';
|
|
131
|
+
titleSeparator?: string;
|
|
132
|
+
sitemap?: 'navigable';
|
|
133
|
+
metatags?: Record<string, string>;
|
|
102
134
|
};
|
|
103
135
|
fonts?: {
|
|
104
136
|
body?: {
|
|
@@ -137,6 +169,10 @@ interface MigrationDocsConfig {
|
|
|
137
169
|
name?: string;
|
|
138
170
|
};
|
|
139
171
|
};
|
|
172
|
+
/** Mintlify `api.playground.display`; `auth` is carried as `simple`. */
|
|
173
|
+
playground?: {
|
|
174
|
+
display: 'interactive' | 'simple' | 'none';
|
|
175
|
+
};
|
|
140
176
|
};
|
|
141
177
|
/** Third-party analytics in Mintlify's `integrations` shape; validated again by the renderer. */
|
|
142
178
|
integrations?: {
|
|
@@ -179,6 +215,9 @@ interface MigrationPage {
|
|
|
179
215
|
locale?: string;
|
|
180
216
|
title: string;
|
|
181
217
|
navTitle?: string;
|
|
218
|
+
/** Sidebar icon name or image URL from page frontmatter, with its optional style. */
|
|
219
|
+
icon?: string;
|
|
220
|
+
iconType?: 'regular' | 'solid' | 'outline' | 'brands';
|
|
182
221
|
description: string;
|
|
183
222
|
/** Keep SEO/search description without repeating it above Docusaurus body copy. */
|
|
184
223
|
descriptionPlacement?: 'body';
|
|
@@ -187,12 +226,16 @@ interface MigrationPage {
|
|
|
187
226
|
mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
|
|
188
227
|
hidden?: boolean;
|
|
189
228
|
noindex?: boolean;
|
|
229
|
+
/** Social/SEO overrides from `og:*` and `twitter:*` frontmatter, keyed by the migrated frontmatter field. */
|
|
230
|
+
meta?: Partial<Record<'ogTitle' | 'ogDescription' | 'ogImage' | 'twitterTitle' | 'twitterDescription' | 'twitterImage', string>>;
|
|
190
231
|
/** OpenAPI operation key rendered by Thally instead of ordinary MDX. */
|
|
191
232
|
openapi?: string;
|
|
192
233
|
/** Manual API page: `METHOD <url-or-path>`; rendered by Thally's playground. */
|
|
193
234
|
api?: string;
|
|
194
235
|
/** Page-level playground auth override: bearer | basic | key | none. */
|
|
195
236
|
authMethod?: string;
|
|
237
|
+
/** Page-level `playground` override: interactive | simple | none (`auth` becomes `simple`). */
|
|
238
|
+
playground?: 'interactive' | 'simple' | 'none';
|
|
196
239
|
body: string;
|
|
197
240
|
source: string;
|
|
198
241
|
/** Set when the page's frontmatter was invalid YAML; the page is kept with a best-effort salvage. */
|