@thallylabs/migrate 0.2.8 → 0.2.9
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 +27 -0
- package/dist/index.js +589 -82
- package/dist/index.js.map +1 -1
- package/package.json +3 -1
package/dist/index.d.ts
CHANGED
|
@@ -41,13 +41,23 @@ interface MigrationNavbarConfig {
|
|
|
41
41
|
href: string;
|
|
42
42
|
type?: 'github';
|
|
43
43
|
}>;
|
|
44
|
+
/** Explicit null suppresses the starter's sample call to action. */
|
|
44
45
|
primary?: {
|
|
45
46
|
label: string;
|
|
46
47
|
href: string;
|
|
48
|
+
} | null;
|
|
49
|
+
/** Local public assets used until an owner uploads a brand replacement. */
|
|
50
|
+
logo?: {
|
|
51
|
+
light: string;
|
|
52
|
+
dark?: string;
|
|
53
|
+
showTitle?: boolean;
|
|
54
|
+
rightText?: string;
|
|
47
55
|
};
|
|
48
56
|
}
|
|
49
57
|
interface MigrationFooterConfig {
|
|
50
58
|
socials?: Record<string, string>;
|
|
59
|
+
/** Literal footer attribution; `{year}` is resolved by the site at render time. */
|
|
60
|
+
copyright?: string;
|
|
51
61
|
links?: Array<{
|
|
52
62
|
heading: string;
|
|
53
63
|
items: Array<{
|
|
@@ -72,6 +82,10 @@ interface MigrationDocsConfig {
|
|
|
72
82
|
};
|
|
73
83
|
banner?: MigrationBannerConfig;
|
|
74
84
|
navbar?: MigrationNavbarConfig;
|
|
85
|
+
favicon?: {
|
|
86
|
+
light: string;
|
|
87
|
+
dark?: string;
|
|
88
|
+
};
|
|
75
89
|
footer?: MigrationFooterConfig;
|
|
76
90
|
seo?: {
|
|
77
91
|
indexing?: 'navigable' | 'all';
|
|
@@ -111,6 +125,8 @@ interface MigrationDocsConfig {
|
|
|
111
125
|
code: string;
|
|
112
126
|
label: string;
|
|
113
127
|
}>;
|
|
128
|
+
/** Source-authored navigation labels and ordering for each translation. */
|
|
129
|
+
navigation?: Record<string, Array<MigrationNavigationTab>>;
|
|
114
130
|
};
|
|
115
131
|
}
|
|
116
132
|
interface MigrationPage {
|
|
@@ -122,6 +138,8 @@ interface MigrationPage {
|
|
|
122
138
|
title: string;
|
|
123
139
|
navTitle?: string;
|
|
124
140
|
description: string;
|
|
141
|
+
/** Keep SEO/search description without repeating it above Docusaurus body copy. */
|
|
142
|
+
descriptionPlacement?: 'body';
|
|
125
143
|
badge?: string;
|
|
126
144
|
keywords: Array<string>;
|
|
127
145
|
mode?: 'default' | 'wide' | 'custom' | 'center' | 'home';
|
|
@@ -312,6 +330,10 @@ interface FernPageDescriptor {
|
|
|
312
330
|
/** Path to the referenced page file, relative to the Fern root. */
|
|
313
331
|
sourcePath: string;
|
|
314
332
|
navigationId: string;
|
|
333
|
+
/** Fern's sidebar label can intentionally differ from the page title. */
|
|
334
|
+
navTitle?: string;
|
|
335
|
+
/** Keep routable pages excluded by Fern's `hidden` navigation flag. */
|
|
336
|
+
hidden?: boolean;
|
|
315
337
|
}
|
|
316
338
|
/** One `api:` navigation node, resolved to the name/tab Thally needs to bind its spec. */
|
|
317
339
|
interface FernApiSection {
|
|
@@ -337,6 +359,11 @@ interface FernNavigationResult {
|
|
|
337
359
|
warnings: Array<MigrationWarning>;
|
|
338
360
|
/** Every `api:` node found in navigation, in document order. A repo can declare several (e.g. a REST and a WebSocket API in separate tabs). */
|
|
339
361
|
apiSections: Array<FernApiSection>;
|
|
362
|
+
/** Fern changelog tabs render their entries as a feed at the bare route. */
|
|
363
|
+
changelogIndexes: Array<{
|
|
364
|
+
route: string;
|
|
365
|
+
entries: Array<string>;
|
|
366
|
+
}>;
|
|
340
367
|
}
|
|
341
368
|
/** Read `fern/docs.yml` without executing anything. */
|
|
342
369
|
declare function readFernConfig(fernRoot: string): {
|