@farming-labs/docs 0.0.2-beta.22 → 0.0.2-beta.24
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.mts +72 -5
- package/dist/index.mjs +1 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -442,6 +442,32 @@ interface PageActionsConfig {
|
|
|
442
442
|
* lastUpdated: { position: "below-title" }
|
|
443
443
|
* ```
|
|
444
444
|
*/
|
|
445
|
+
/**
|
|
446
|
+
* Configuration for auto-generated `/llms.txt` and `/llms-full.txt` routes.
|
|
447
|
+
*
|
|
448
|
+
* @see https://llmstxt.org
|
|
449
|
+
*/
|
|
450
|
+
interface LlmsTxtConfig {
|
|
451
|
+
/**
|
|
452
|
+
* Whether to enable llms.txt generation.
|
|
453
|
+
* @default true
|
|
454
|
+
*/
|
|
455
|
+
enabled?: boolean;
|
|
456
|
+
/**
|
|
457
|
+
* Base URL for your docs site (used to build absolute links in llms.txt).
|
|
458
|
+
* @example "https://docs.example.com"
|
|
459
|
+
*/
|
|
460
|
+
baseUrl?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Site title shown at the top of llms.txt.
|
|
463
|
+
* Falls back to `nav.title` if not set.
|
|
464
|
+
*/
|
|
465
|
+
siteTitle?: string;
|
|
466
|
+
/**
|
|
467
|
+
* Site description shown below the title.
|
|
468
|
+
*/
|
|
469
|
+
siteDescription?: string;
|
|
470
|
+
}
|
|
445
471
|
interface LastUpdatedConfig {
|
|
446
472
|
/**
|
|
447
473
|
* Whether to show the "Last updated" date.
|
|
@@ -731,11 +757,37 @@ interface AIConfig {
|
|
|
731
757
|
*/
|
|
732
758
|
docsUrl?: string;
|
|
733
759
|
/**
|
|
734
|
-
*
|
|
735
|
-
*
|
|
760
|
+
* Loading indicator variant shown while the AI generates a response.
|
|
761
|
+
*
|
|
762
|
+
* - `"shimmer-dots"` — shimmer text + typing dots (default)
|
|
763
|
+
* - `"circular"` — spinning ring
|
|
764
|
+
* - `"dots"` — bouncing dots
|
|
765
|
+
* - `"typing"` — typing dots
|
|
766
|
+
* - `"wave"` — wave bars
|
|
767
|
+
* - `"bars"` — thick wave bars
|
|
768
|
+
* - `"pulse"` — pulsing ring
|
|
769
|
+
* - `"pulse-dot"` — pulsing dot
|
|
770
|
+
* - `"terminal"` — blinking terminal cursor
|
|
771
|
+
* - `"text-blink"` — blinking text
|
|
772
|
+
* - `"text-shimmer"` — shimmer text only
|
|
773
|
+
* - `"loading-dots"` — "Thinking..." with animated dots
|
|
774
|
+
*
|
|
775
|
+
* @default "shimmer-dots"
|
|
736
776
|
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
777
|
+
* @example
|
|
778
|
+
* ```ts
|
|
779
|
+
* ai: {
|
|
780
|
+
* enabled: true,
|
|
781
|
+
* loader: "wave",
|
|
782
|
+
* }
|
|
783
|
+
* ```
|
|
784
|
+
*/
|
|
785
|
+
loader?: "shimmer-dots" | "circular" | "dots" | "typing" | "wave" | "bars" | "pulse" | "pulse-dot" | "terminal" | "text-blink" | "text-shimmer" | "loading-dots";
|
|
786
|
+
/**
|
|
787
|
+
* Custom loading indicator that overrides the built-in `loader` variant.
|
|
788
|
+
* Receives `{ name }` (the `aiLabel` value) and returns a React element.
|
|
789
|
+
*
|
|
790
|
+
* Only works in Next.js. For other frameworks, use the `loader` option.
|
|
739
791
|
*
|
|
740
792
|
* @example
|
|
741
793
|
* ```tsx
|
|
@@ -1003,6 +1055,21 @@ interface DocsConfig {
|
|
|
1003
1055
|
* ```
|
|
1004
1056
|
*/
|
|
1005
1057
|
ordering?: "alphabetical" | "numeric" | OrderingItem[];
|
|
1058
|
+
/**
|
|
1059
|
+
* Auto-generate `/llms.txt` and `/llms-full.txt` routes for LLM-friendly
|
|
1060
|
+
* documentation. These files let AI tools quickly understand your docs.
|
|
1061
|
+
*
|
|
1062
|
+
* @example
|
|
1063
|
+
* ```ts
|
|
1064
|
+
* llmsTxt: {
|
|
1065
|
+
* enabled: true,
|
|
1066
|
+
* baseUrl: "https://docs.example.com",
|
|
1067
|
+
* }
|
|
1068
|
+
* ```
|
|
1069
|
+
*
|
|
1070
|
+
* @see https://llmstxt.org
|
|
1071
|
+
*/
|
|
1072
|
+
llmsTxt?: boolean | LlmsTxtConfig;
|
|
1006
1073
|
/** SEO metadata - separate from theme */
|
|
1007
1074
|
metadata?: DocsMetadata;
|
|
1008
1075
|
/** Open Graph image handling */
|
|
@@ -1078,4 +1145,4 @@ declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): strin
|
|
|
1078
1145
|
*/
|
|
1079
1146
|
declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
|
|
1080
1147
|
//#endregion
|
|
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 };
|
|
1148
|
+
export { type AIConfig, type BreadcrumbConfig, type CopyMarkdownConfig, type DocsConfig, type DocsMetadata, type DocsNav, type DocsTheme, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, 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