@farming-labs/docs 0.0.2-beta.17 → 0.0.2-beta.19
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/cli/index.mjs +58 -0
- package/dist/index.d.mts +64 -2
- package/dist/index.mjs +1 -0
- package/package.json +1 -1
package/dist/cli/index.mjs
CHANGED
|
@@ -176,6 +176,39 @@ const THEME_INFO = {
|
|
|
176
176
|
svelteCssTheme: "colorful",
|
|
177
177
|
astroCssTheme: "colorful",
|
|
178
178
|
nuxtCssTheme: "colorful"
|
|
179
|
+
},
|
|
180
|
+
darkbold: {
|
|
181
|
+
factory: "darkbold",
|
|
182
|
+
nextImport: "@farming-labs/theme/darkbold",
|
|
183
|
+
svelteImport: "@farming-labs/svelte-theme/darkbold",
|
|
184
|
+
astroImport: "@farming-labs/astro-theme/darkbold",
|
|
185
|
+
nuxtImport: "@farming-labs/nuxt-theme/darkbold",
|
|
186
|
+
nextCssImport: "darkbold",
|
|
187
|
+
svelteCssTheme: "darkbold",
|
|
188
|
+
astroCssTheme: "darkbold",
|
|
189
|
+
nuxtCssTheme: "darkbold"
|
|
190
|
+
},
|
|
191
|
+
shiny: {
|
|
192
|
+
factory: "shiny",
|
|
193
|
+
nextImport: "@farming-labs/theme/shiny",
|
|
194
|
+
svelteImport: "@farming-labs/svelte-theme/shiny",
|
|
195
|
+
astroImport: "@farming-labs/astro-theme/shiny",
|
|
196
|
+
nuxtImport: "@farming-labs/nuxt-theme/shiny",
|
|
197
|
+
nextCssImport: "shiny",
|
|
198
|
+
svelteCssTheme: "shiny",
|
|
199
|
+
astroCssTheme: "shiny",
|
|
200
|
+
nuxtCssTheme: "shiny"
|
|
201
|
+
},
|
|
202
|
+
greentree: {
|
|
203
|
+
factory: "greentree",
|
|
204
|
+
nextImport: "@farming-labs/theme/greentree",
|
|
205
|
+
svelteImport: "@farming-labs/svelte-theme/greentree",
|
|
206
|
+
astroImport: "@farming-labs/astro-theme/greentree",
|
|
207
|
+
nuxtImport: "@farming-labs/nuxt-theme/greentree",
|
|
208
|
+
nextCssImport: "greentree",
|
|
209
|
+
svelteCssTheme: "greentree",
|
|
210
|
+
astroCssTheme: "greentree",
|
|
211
|
+
nuxtCssTheme: "greentree"
|
|
179
212
|
}
|
|
180
213
|
};
|
|
181
214
|
function getThemeInfo(theme) {
|
|
@@ -1508,6 +1541,21 @@ async function init() {
|
|
|
1508
1541
|
value: "colorful",
|
|
1509
1542
|
label: "Colorful",
|
|
1510
1543
|
hint: "Fumadocs-style neutral theme with description support"
|
|
1544
|
+
},
|
|
1545
|
+
{
|
|
1546
|
+
value: "darkbold",
|
|
1547
|
+
label: "DarkBold",
|
|
1548
|
+
hint: "Pure monochrome, Geist typography, clean minimalism"
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
value: "shiny",
|
|
1552
|
+
label: "Shiny",
|
|
1553
|
+
hint: "Glossy, modern look with subtle shimmer effects"
|
|
1554
|
+
},
|
|
1555
|
+
{
|
|
1556
|
+
value: "greentree",
|
|
1557
|
+
label: "GreenTree",
|
|
1558
|
+
hint: "Emerald green accent, Inter font, Mintlify-inspired"
|
|
1511
1559
|
}
|
|
1512
1560
|
]
|
|
1513
1561
|
});
|
|
@@ -1764,6 +1812,9 @@ function scaffoldSvelteKit(cwd, cfg, globalCssRelPath, write, skipped, written)
|
|
|
1764
1812
|
darksharp: "darksharp",
|
|
1765
1813
|
"pixel-border": "pixel-border",
|
|
1766
1814
|
colorful: "colorful",
|
|
1815
|
+
darkbold: "darkbold",
|
|
1816
|
+
shiny: "shiny",
|
|
1817
|
+
greentree: "greentree",
|
|
1767
1818
|
default: "fumadocs"
|
|
1768
1819
|
}[cfg.theme] || "fumadocs";
|
|
1769
1820
|
if (existingGlobalCss) {
|
|
@@ -1791,6 +1842,9 @@ function scaffoldAstro(cwd, cfg, globalCssRelPath, write, skipped, written) {
|
|
|
1791
1842
|
darksharp: "darksharp",
|
|
1792
1843
|
"pixel-border": "pixel-border",
|
|
1793
1844
|
colorful: "colorful",
|
|
1845
|
+
darkbold: "darkbold",
|
|
1846
|
+
shiny: "shiny",
|
|
1847
|
+
greentree: "greentree",
|
|
1794
1848
|
default: "fumadocs"
|
|
1795
1849
|
}[cfg.theme] || "fumadocs";
|
|
1796
1850
|
if (existingGlobalCss) {
|
|
@@ -1817,6 +1871,10 @@ function scaffoldNuxt(cwd, cfg, globalCssRelPath, write, skipped, written) {
|
|
|
1817
1871
|
fumadocs: "fumadocs",
|
|
1818
1872
|
darksharp: "darksharp",
|
|
1819
1873
|
"pixel-border": "pixel-border",
|
|
1874
|
+
colorful: "colorful",
|
|
1875
|
+
darkbold: "darkbold",
|
|
1876
|
+
shiny: "shiny",
|
|
1877
|
+
greentree: "greentree",
|
|
1820
1878
|
default: "fumadocs"
|
|
1821
1879
|
}[cfg.theme] || "fumadocs";
|
|
1822
1880
|
const globalCssAbsPath = path.join(cwd, globalCssRelPath);
|
package/dist/index.d.mts
CHANGED
|
@@ -328,6 +328,17 @@ interface SidebarConfig {
|
|
|
328
328
|
* @default true
|
|
329
329
|
*/
|
|
330
330
|
collapsible?: boolean;
|
|
331
|
+
/**
|
|
332
|
+
* When true, all folder children are rendered flat in the sidebar
|
|
333
|
+
* (no collapsible sections). Folder index pages appear as category
|
|
334
|
+
* headings with all children listed directly below them.
|
|
335
|
+
*
|
|
336
|
+
* This creates a Mintlify-style sidebar where all navigation items
|
|
337
|
+
* are always visible.
|
|
338
|
+
*
|
|
339
|
+
* @default false
|
|
340
|
+
*/
|
|
341
|
+
flat?: boolean;
|
|
331
342
|
}
|
|
332
343
|
/**
|
|
333
344
|
* A single "Open in …" provider shown in the Open dropdown.
|
|
@@ -413,6 +424,39 @@ interface PageActionsConfig {
|
|
|
413
424
|
* @default "below-title"
|
|
414
425
|
*/
|
|
415
426
|
position?: "above-title" | "below-title";
|
|
427
|
+
/**
|
|
428
|
+
* Horizontal alignment of page action buttons.
|
|
429
|
+
*
|
|
430
|
+
* - `"left"` — align to the left (default)
|
|
431
|
+
* - `"right"` — align to the right
|
|
432
|
+
*
|
|
433
|
+
* @default "left"
|
|
434
|
+
*/
|
|
435
|
+
alignment?: "left" | "right";
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* Configuration for the "Last updated" date display.
|
|
439
|
+
*
|
|
440
|
+
* @example
|
|
441
|
+
* ```ts
|
|
442
|
+
* lastUpdated: { position: "below-title" }
|
|
443
|
+
* ```
|
|
444
|
+
*/
|
|
445
|
+
interface LastUpdatedConfig {
|
|
446
|
+
/**
|
|
447
|
+
* Whether to show the "Last updated" date.
|
|
448
|
+
* @default true
|
|
449
|
+
*/
|
|
450
|
+
enabled?: boolean;
|
|
451
|
+
/**
|
|
452
|
+
* Where to render the "Last updated" date.
|
|
453
|
+
*
|
|
454
|
+
* - `"footer"` — next to the "Edit on GitHub" link at the bottom (default)
|
|
455
|
+
* - `"below-title"` — below the page title/description, above the content
|
|
456
|
+
*
|
|
457
|
+
* @default "footer"
|
|
458
|
+
*/
|
|
459
|
+
position?: "footer" | "below-title";
|
|
416
460
|
}
|
|
417
461
|
/**
|
|
418
462
|
* GitHub repository configuration for "Edit on GitHub" links
|
|
@@ -496,7 +540,7 @@ interface AIConfig {
|
|
|
496
540
|
* }
|
|
497
541
|
* ```
|
|
498
542
|
*/
|
|
499
|
-
mode?: "search" | "floating";
|
|
543
|
+
mode?: "search" | "floating" | "sidebar-icon";
|
|
500
544
|
/**
|
|
501
545
|
* Position of the floating chat button on screen.
|
|
502
546
|
* Only used when `mode` is `"floating"`.
|
|
@@ -874,6 +918,24 @@ interface DocsConfig {
|
|
|
874
918
|
* ```
|
|
875
919
|
*/
|
|
876
920
|
pageActions?: PageActionsConfig;
|
|
921
|
+
/**
|
|
922
|
+
* Configuration for the "Last updated" date display.
|
|
923
|
+
*
|
|
924
|
+
* - `true` or `undefined` → shown in footer next to "Edit on GitHub" (default)
|
|
925
|
+
* - `false` → hidden
|
|
926
|
+
* - `{ position: "below-title" }` → shown below the page title
|
|
927
|
+
* - `{ position: "footer" }` → shown next to "Edit on GitHub" (default)
|
|
928
|
+
*
|
|
929
|
+
* @example
|
|
930
|
+
* ```ts
|
|
931
|
+
* // Show below title (Mintlify style)
|
|
932
|
+
* lastUpdated: { position: "below-title" }
|
|
933
|
+
*
|
|
934
|
+
* // Hide entirely
|
|
935
|
+
* lastUpdated: false
|
|
936
|
+
* ```
|
|
937
|
+
*/
|
|
938
|
+
lastUpdated?: boolean | LastUpdatedConfig;
|
|
877
939
|
/**
|
|
878
940
|
* AI-powered "Ask AI" chat for documentation.
|
|
879
941
|
*
|
|
@@ -1016,4 +1078,4 @@ declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): strin
|
|
|
1016
1078
|
*/
|
|
1017
1079
|
declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
|
|
1018
1080
|
//#endregion
|
|
1019
|
-
export { type AIConfig, type BreadcrumbConfig, type CopyMarkdownConfig, type DocsConfig, type DocsMetadata, type DocsNav, type DocsTheme, type FontStyle, type GithubConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type SidebarConfig, type ThemeToggleConfig, type TypographyConfig, type UIConfig, createTheme, deepMerge, defineDocs, extendTheme, resolveOGImage, resolveTitle };
|
|
1081
|
+
export { type AIConfig, type BreadcrumbConfig, type CopyMarkdownConfig, type DocsConfig, type DocsMetadata, type DocsNav, type DocsTheme, type FontStyle, type GithubConfig, type LastUpdatedConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type SidebarConfig, type ThemeToggleConfig, type TypographyConfig, type UIConfig, createTheme, deepMerge, defineDocs, extendTheme, resolveOGImage, resolveTitle };
|
package/dist/index.mjs
CHANGED