@farming-labs/docs 0.0.2-beta.21 → 0.0.2-beta.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.mts +42 -1
- package/dist/index.mjs +1 -0
- package/package.json +14 -14
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.
|
|
@@ -1003,6 +1029,21 @@ interface DocsConfig {
|
|
|
1003
1029
|
* ```
|
|
1004
1030
|
*/
|
|
1005
1031
|
ordering?: "alphabetical" | "numeric" | OrderingItem[];
|
|
1032
|
+
/**
|
|
1033
|
+
* Auto-generate `/llms.txt` and `/llms-full.txt` routes for LLM-friendly
|
|
1034
|
+
* documentation. These files let AI tools quickly understand your docs.
|
|
1035
|
+
*
|
|
1036
|
+
* @example
|
|
1037
|
+
* ```ts
|
|
1038
|
+
* llmsTxt: {
|
|
1039
|
+
* enabled: true,
|
|
1040
|
+
* baseUrl: "https://docs.example.com",
|
|
1041
|
+
* }
|
|
1042
|
+
* ```
|
|
1043
|
+
*
|
|
1044
|
+
* @see https://llmstxt.org
|
|
1045
|
+
*/
|
|
1046
|
+
llmsTxt?: boolean | LlmsTxtConfig;
|
|
1006
1047
|
/** SEO metadata - separate from theme */
|
|
1007
1048
|
metadata?: DocsMetadata;
|
|
1008
1049
|
/** Open Graph image handling */
|
|
@@ -1078,4 +1119,4 @@ declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): strin
|
|
|
1078
1119
|
*/
|
|
1079
1120
|
declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
|
|
1080
1121
|
//#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 };
|
|
1122
|
+
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
package/package.json
CHANGED
|
@@ -1,7 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farming-labs/docs",
|
|
3
|
-
"version": "0.0.2-beta.
|
|
3
|
+
"version": "0.0.2-beta.23",
|
|
4
4
|
"description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"docs",
|
|
7
|
+
"documentation",
|
|
8
|
+
"mdx"
|
|
9
|
+
],
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"author": "Farming Labs",
|
|
12
|
+
"bin": {
|
|
13
|
+
"docs": "./dist/cli/index.mjs"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist"
|
|
17
|
+
],
|
|
5
18
|
"type": "module",
|
|
6
19
|
"main": "./dist/index.mjs",
|
|
7
20
|
"module": "./dist/index.mjs",
|
|
@@ -13,19 +26,6 @@
|
|
|
13
26
|
"default": "./dist/index.mjs"
|
|
14
27
|
}
|
|
15
28
|
},
|
|
16
|
-
"bin": {
|
|
17
|
-
"docs": "./dist/cli/index.mjs"
|
|
18
|
-
},
|
|
19
|
-
"files": [
|
|
20
|
-
"dist"
|
|
21
|
-
],
|
|
22
|
-
"keywords": [
|
|
23
|
-
"docs",
|
|
24
|
-
"mdx",
|
|
25
|
-
"documentation"
|
|
26
|
-
],
|
|
27
|
-
"author": "Farming Labs",
|
|
28
|
-
"license": "MIT",
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"@clack/prompts": "^0.9.1",
|
|
31
31
|
"gray-matter": "^4.0.3",
|