@farming-labs/docs 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/cli/index.mjs +2 -2
- package/dist/{dev-D58nBPBv.mjs → dev-C5rHIIpC.mjs} +1 -1
- package/dist/index.d.mts +2 -2
- package/dist/{init-DeeHyP-N.mjs → init-D-Ki2dWn.mjs} +5 -10
- package/dist/mcp.d.mts +1 -1
- package/dist/{search-CLEqfXEI.d.mts → search-D-iBv3VC.d.mts} +1 -1
- package/dist/server.d.mts +2 -2
- package/dist/{templates-JtyB8x53.mjs → templates-CMcXQ0Gk.mjs} +1 -1
- package/dist/{types-Ceem9QVI.d.mts → types-BCEobEGw.d.mts} +4 -3
- package/package.json +2 -2
package/dist/cli/index.mjs
CHANGED
|
@@ -98,10 +98,10 @@ async function main() {
|
|
|
98
98
|
]
|
|
99
99
|
};
|
|
100
100
|
if (!parsedCommand.command || parsedCommand.command === "init") {
|
|
101
|
-
const { init } = await import("../init-
|
|
101
|
+
const { init } = await import("../init-D-Ki2dWn.mjs");
|
|
102
102
|
await init(initOptions);
|
|
103
103
|
} else if (parsedCommand.command === "dev") {
|
|
104
|
-
const { dev } = await import("../dev-
|
|
104
|
+
const { dev } = await import("../dev-C5rHIIpC.mjs");
|
|
105
105
|
await dev(devOptions);
|
|
106
106
|
} else if (parsedCommand.command === "deploy") {
|
|
107
107
|
const { runCloudDeploy } = await import("../cloud-DLc03Z41.mjs");
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { i as detectPackageManagerFromLockfile } from "./utils-CGlOADu1.mjs";
|
|
2
|
-
import { K as rootLayoutTemplate, W as postcssConfigTemplate, g as docsLayoutTemplate, v as globalCssTemplate, yt as tsconfigTemplate } from "./templates-
|
|
2
|
+
import { K as rootLayoutTemplate, W as postcssConfigTemplate, g as docsLayoutTemplate, v as globalCssTemplate, yt as tsconfigTemplate } from "./templates-CMcXQ0Gk.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as DocsObservabilityEvent, $t as SidebarPageNode, A as DocsAskAIMcpConfig, At as LlmsTxtSectionConfig, B as DocsCodeBlocksRunnerProvider, Bt as PageActionsConfig, C as DocsAnalyticsSource, Ct as FeedbackConfig, D as DocsAskAIFeedbackData, Dt as LlmsTxtConfig, E as DocsAskAIFeedbackConfig, Et as LastUpdatedConfig, F as DocsCloudPublishConfig, Ft as OpenDocsProviderConfig, G as DocsFeedbackData, Gt as ReadingTimeConfig, H as DocsCodeBlocksValidationMode, Ht as PageOpenGraph, I as DocsCodeBlocksConfig, It as OpenDocsProviderId, J as DocsMcpConfig, Jt as SidebarComponentProps, K as DocsFeedbackValue, Kt as ReadingTimeFormat, L as DocsCodeBlocksPlannerConfig, Lt as OpenDocsTarget, M as DocsCloudConfig, Mt as OGConfig, N as DocsCloudFeatureConfig, Nt as OpenDocsConfig, O as DocsAskAIFeedbackMessage, Ot as LlmsTxtMaxCharsConfig, P as DocsCloudPreviewConfig, Pt as OpenDocsProvider, Q as DocsObservabilityConfig, Qt as SidebarNode, R as DocsCodeBlocksPlannerProvider, Rt as OpenGraphImage, S as DocsAnalyticsInput, St as DocsTheme, T as DocsAskAIActionType, Tt as GithubConfig, U as DocsCodeBlocksValidationPolicy, Ut as PageSidebarFrontmatter, V as DocsCodeBlocksValidateConfig, Vt as PageFrontmatter, W as DocsConfig, Wt as PageTwitter, X as DocsMetadata, Xt as SidebarFolderIndexBehavior, Y as DocsMcpToolsConfig, Yt as SidebarConfig, Z as DocsNav, Zt as SidebarFolderNode, _ as DocsAgentTraceStatus, _t as DocsSearchQuery, a as ApiReferenceRenderer, an as UIConfig, at as DocsReviewRulesConfig, b as DocsAnalyticsEventInput, bt as DocsSearchSourcePage, c as ChangelogFrontmatter, ct as DocsRobotsConfig, d as CopyMarkdownFormat, dt as DocsSearchAdapterContext, en as SidebarTree, et as DocsObservabilityEventInput, f as CustomDocsSearchConfig, ft as DocsSearchAdapterFactory, g as DocsAgentTraceEventType, gt as DocsSearchEmbeddingsConfig, h as DocsAgentTraceEventInput, ht as DocsSearchDocument, i as ApiReferenceConfig, in as TypographyConfig, it as DocsReviewConfig, j as DocsCloudApiKeyConfig, jt as McpDocsSearchConfig, k as DocsAskAIFeedbackValue, kt as LlmsTxtMaxCharsMode, l as CodeBlockCopyData, lt as DocsRobotsRule, m as DocsAgentFeedbackData, mt as DocsSearchConfig, n as AgentFeedbackConfig, nn as ThemeToggleConfig, nt as DocsReviewCiConfig, o as BreadcrumbConfig, ot as DocsReviewScoreConfig, p as DocsAgentFeedbackContext, pt as DocsSearchChunkingConfig, q as DocsI18nConfig, qt as ResolvedDocsRelatedLink, r as AlgoliaDocsSearchConfig, rn as TypesenseDocsSearchConfig, rt as DocsReviewCiMode, s as ChangelogConfig, st as DocsReviewSeverity, t as AIConfig, tn as SimpleDocsSearchConfig, tt as DocsRelatedItem, u as CopyMarkdownConfig, ut as DocsSearchAdapter, v as DocsAnalyticsConfig, vt as DocsSearchResult, w as DocsAskAIActionData, wt as FontStyle, x as DocsAnalyticsEventType, xt as DocsSitemapConfig, y as DocsAnalyticsEvent, yt as DocsSearchResultType, z as DocsCodeBlocksRunnerConfig, zt as OrderingItem } from "./types-
|
|
2
|
-
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-
|
|
1
|
+
import { $ as DocsObservabilityEvent, $t as SidebarPageNode, A as DocsAskAIMcpConfig, At as LlmsTxtSectionConfig, B as DocsCodeBlocksRunnerProvider, Bt as PageActionsConfig, C as DocsAnalyticsSource, Ct as FeedbackConfig, D as DocsAskAIFeedbackData, Dt as LlmsTxtConfig, E as DocsAskAIFeedbackConfig, Et as LastUpdatedConfig, F as DocsCloudPublishConfig, Ft as OpenDocsProviderConfig, G as DocsFeedbackData, Gt as ReadingTimeConfig, H as DocsCodeBlocksValidationMode, Ht as PageOpenGraph, I as DocsCodeBlocksConfig, It as OpenDocsProviderId, J as DocsMcpConfig, Jt as SidebarComponentProps, K as DocsFeedbackValue, Kt as ReadingTimeFormat, L as DocsCodeBlocksPlannerConfig, Lt as OpenDocsTarget, M as DocsCloudConfig, Mt as OGConfig, N as DocsCloudFeatureConfig, Nt as OpenDocsConfig, O as DocsAskAIFeedbackMessage, Ot as LlmsTxtMaxCharsConfig, P as DocsCloudPreviewConfig, Pt as OpenDocsProvider, Q as DocsObservabilityConfig, Qt as SidebarNode, R as DocsCodeBlocksPlannerProvider, Rt as OpenGraphImage, S as DocsAnalyticsInput, St as DocsTheme, T as DocsAskAIActionType, Tt as GithubConfig, U as DocsCodeBlocksValidationPolicy, Ut as PageSidebarFrontmatter, V as DocsCodeBlocksValidateConfig, Vt as PageFrontmatter, W as DocsConfig, Wt as PageTwitter, X as DocsMetadata, Xt as SidebarFolderIndexBehavior, Y as DocsMcpToolsConfig, Yt as SidebarConfig, Z as DocsNav, Zt as SidebarFolderNode, _ as DocsAgentTraceStatus, _t as DocsSearchQuery, a as ApiReferenceRenderer, an as UIConfig, at as DocsReviewRulesConfig, b as DocsAnalyticsEventInput, bt as DocsSearchSourcePage, c as ChangelogFrontmatter, ct as DocsRobotsConfig, d as CopyMarkdownFormat, dt as DocsSearchAdapterContext, en as SidebarTree, et as DocsObservabilityEventInput, f as CustomDocsSearchConfig, ft as DocsSearchAdapterFactory, g as DocsAgentTraceEventType, gt as DocsSearchEmbeddingsConfig, h as DocsAgentTraceEventInput, ht as DocsSearchDocument, i as ApiReferenceConfig, in as TypographyConfig, it as DocsReviewConfig, j as DocsCloudApiKeyConfig, jt as McpDocsSearchConfig, k as DocsAskAIFeedbackValue, kt as LlmsTxtMaxCharsMode, l as CodeBlockCopyData, lt as DocsRobotsRule, m as DocsAgentFeedbackData, mt as DocsSearchConfig, n as AgentFeedbackConfig, nn as ThemeToggleConfig, nt as DocsReviewCiConfig, o as BreadcrumbConfig, ot as DocsReviewScoreConfig, p as DocsAgentFeedbackContext, pt as DocsSearchChunkingConfig, q as DocsI18nConfig, qt as ResolvedDocsRelatedLink, r as AlgoliaDocsSearchConfig, rn as TypesenseDocsSearchConfig, rt as DocsReviewCiMode, s as ChangelogConfig, st as DocsReviewSeverity, t as AIConfig, tn as SimpleDocsSearchConfig, tt as DocsRelatedItem, u as CopyMarkdownConfig, ut as DocsSearchAdapter, v as DocsAnalyticsConfig, vt as DocsSearchResult, w as DocsAskAIActionData, wt as FontStyle, x as DocsAnalyticsEventType, xt as DocsSitemapConfig, y as DocsAnalyticsEvent, yt as DocsSearchResultType, z as DocsCodeBlocksRunnerConfig, zt as OrderingItem } from "./types-BCEobEGw.mjs";
|
|
2
|
+
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-D-iBv3VC.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/define-docs.d.ts
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { a as devInstallCommand, c as fileExists, d as spawnAndWaitFor, f as writeFileSafe, i as detectPackageManagerFromLockfile, l as installCommand, n as detectGlobalCssFiles, o as exec, r as detectNextAppDir, t as detectFramework, u as readFileSafe } from "./utils-CGlOADu1.mjs";
|
|
2
|
-
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-
|
|
2
|
+
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-CMcXQ0Gk.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
|
@@ -791,9 +791,10 @@ async function init(options = {}) {
|
|
|
791
791
|
p.log.info(`Using ${pc.cyan(pm)} as package manager`);
|
|
792
792
|
const s2 = p.spinner();
|
|
793
793
|
s2.start("Installing dependencies");
|
|
794
|
+
const docsRuntimeInstallCommand = framework === "tanstack-start" ? `${installCommand(pm)} @farming-labs/docs @farming-labs/theme @farming-labs/tanstack-start` : framework === "sveltekit" ? `${installCommand(pm)} @farming-labs/docs @farming-labs/svelte @farming-labs/svelte-theme` : framework === "astro" ? `${installCommand(pm)} @farming-labs/docs @farming-labs/astro @farming-labs/astro-theme ${getAstroAdapterPkg(cfg.astroAdapter ?? "vercel")}` : framework === "nuxt" ? `${installCommand(pm)} @farming-labs/docs @farming-labs/nuxt @farming-labs/nuxt-theme` : `${installCommand(pm)} @farming-labs/docs @farming-labs/next @farming-labs/theme`;
|
|
794
795
|
try {
|
|
796
|
+
exec(docsRuntimeInstallCommand, cwd);
|
|
795
797
|
if (framework === "tanstack-start") {
|
|
796
|
-
exec(`${installCommand(pm)} @farming-labs/docs @farming-labs/theme @farming-labs/tanstack-start`, cwd);
|
|
797
798
|
const devDeps = ["@tailwindcss/vite", "tailwindcss"];
|
|
798
799
|
if (useAlias) devDeps.push("vite-tsconfig-paths");
|
|
799
800
|
const allDeps = {
|
|
@@ -802,13 +803,7 @@ async function init(options = {}) {
|
|
|
802
803
|
};
|
|
803
804
|
const missingDevDeps = devDeps.filter((d) => !allDeps[d]);
|
|
804
805
|
if (missingDevDeps.length > 0) exec(`${devInstallCommand(pm)} ${missingDevDeps.join(" ")}`, cwd);
|
|
805
|
-
} else if (framework === "
|
|
806
|
-
else if (framework === "astro") {
|
|
807
|
-
const adapterPkg = getAstroAdapterPkg(cfg.astroAdapter ?? "vercel");
|
|
808
|
-
exec(`${installCommand(pm)} @farming-labs/docs @farming-labs/astro @farming-labs/astro-theme ${adapterPkg}`, cwd);
|
|
809
|
-
} else if (framework === "nuxt") exec(`${installCommand(pm)} @farming-labs/docs @farming-labs/nuxt @farming-labs/nuxt-theme`, cwd);
|
|
810
|
-
else {
|
|
811
|
-
exec(`${installCommand(pm)} @farming-labs/docs @farming-labs/next @farming-labs/theme`, cwd);
|
|
806
|
+
} else if (framework === "nextjs") {
|
|
812
807
|
const devDeps = [
|
|
813
808
|
"@tailwindcss/postcss",
|
|
814
809
|
"postcss",
|
|
@@ -826,7 +821,7 @@ async function init(options = {}) {
|
|
|
826
821
|
} catch {
|
|
827
822
|
s2.stop("Failed to install dependencies");
|
|
828
823
|
p.log.error(`Dependency installation failed. Run the install command manually:
|
|
829
|
-
${pc.cyan(
|
|
824
|
+
${pc.cyan(docsRuntimeInstallCommand)}`);
|
|
830
825
|
p.outro(pc.yellow("Setup partially complete. Install deps and run dev server manually."));
|
|
831
826
|
process.exit(1);
|
|
832
827
|
}
|
package/dist/mcp.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { J as DocsMcpConfig, Q as DocsObservabilityConfig, bt as DocsSearchSourcePage, mt as DocsSearchConfig, v as DocsAnalyticsConfig, zt as OrderingItem } from "./types-
|
|
1
|
+
import { J as DocsMcpConfig, Q as DocsObservabilityConfig, bt as DocsSearchSourcePage, mt as DocsSearchConfig, v as DocsAnalyticsConfig, zt as OrderingItem } from "./types-BCEobEGw.mjs";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
|
|
4
4
|
//#region src/mcp.d.ts
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $ as DocsObservabilityEvent, A as DocsAskAIMcpConfig, Lt as OpenDocsTarget, Pt as OpenDocsProvider, Q as DocsObservabilityConfig, b as DocsAnalyticsEventInput, bt as DocsSearchSourcePage, et as DocsObservabilityEventInput, f as CustomDocsSearchConfig, ft as DocsSearchAdapterFactory, h as DocsAgentTraceEventInput, ht as DocsSearchDocument, jt as McpDocsSearchConfig, mt as DocsSearchConfig, pt as DocsSearchChunkingConfig, qt as ResolvedDocsRelatedLink, r as AlgoliaDocsSearchConfig, rn as TypesenseDocsSearchConfig, ut as DocsSearchAdapter, v as DocsAnalyticsConfig, vt as DocsSearchResult, xt as DocsSitemapConfig, y as DocsAnalyticsEvent } from "./types-
|
|
1
|
+
import { $ as DocsObservabilityEvent, A as DocsAskAIMcpConfig, Lt as OpenDocsTarget, Pt as OpenDocsProvider, Q as DocsObservabilityConfig, b as DocsAnalyticsEventInput, bt as DocsSearchSourcePage, et as DocsObservabilityEventInput, f as CustomDocsSearchConfig, ft as DocsSearchAdapterFactory, h as DocsAgentTraceEventInput, ht as DocsSearchDocument, jt as McpDocsSearchConfig, mt as DocsSearchConfig, pt as DocsSearchChunkingConfig, qt as ResolvedDocsRelatedLink, r as AlgoliaDocsSearchConfig, rn as TypesenseDocsSearchConfig, ut as DocsSearchAdapter, v as DocsAnalyticsConfig, vt as DocsSearchResult, xt as DocsSitemapConfig, y as DocsAnalyticsEvent } from "./types-BCEobEGw.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/analytics.d.ts
|
|
4
4
|
declare const DOCS_AGENT_TRACE_EVENT_TYPES: readonly ["run.start", "run.end", "run.error", "user.input", "prompt.build", "retrieval.query", "retrieval.result", "retrieval.error", "model.call", "model.response", "model.stream", "model.error", "tool.call", "tool.result", "tool.error", "retry", "timeout", "error", "agent.final"];
|
package/dist/server.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as DocsObservabilityEvent, A as DocsAskAIMcpConfig, D as DocsAskAIFeedbackData, E as DocsAskAIFeedbackConfig, O as DocsAskAIFeedbackMessage, Q as DocsObservabilityConfig, W as DocsConfig, _ as DocsAgentTraceStatus, _t as DocsSearchQuery, a as ApiReferenceRenderer, at as DocsReviewRulesConfig, b as DocsAnalyticsEventInput, bt as DocsSearchSourcePage, dt as DocsSearchAdapterContext, et as DocsObservabilityEventInput, ft as DocsSearchAdapterFactory, g as DocsAgentTraceEventType, h as DocsAgentTraceEventInput, ht as DocsSearchDocument, it as DocsReviewConfig, jt as McpDocsSearchConfig, k as DocsAskAIFeedbackValue, mt as DocsSearchConfig, rt as DocsReviewCiMode, ut as DocsSearchAdapter, v as DocsAnalyticsConfig, vt as DocsSearchResult, xt as DocsSitemapConfig, y as DocsAnalyticsEvent } from "./types-
|
|
2
|
-
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, B as normalizePromptProviderName, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, F as DEFAULT_PROMPT_PROVIDER_TEMPLATES, G as serializeDocsIconRegistry, H as resolvePromptProviderChoices, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, K as serializeOpenDocsProvider, L as PromptProviderChoice, M as DEFAULT_OPEN_DOCS_PROMPT, N as DEFAULT_OPEN_DOCS_PROVIDER_IDS, O as resolveDocsSitemapConfig, P as DEFAULT_OPEN_DOCS_TARGET, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, U as sanitizePromptText, V as parsePromptStringArray, W as serializeDocsIcon, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as serializeOpenDocsProviders, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-
|
|
1
|
+
import { $ as DocsObservabilityEvent, A as DocsAskAIMcpConfig, D as DocsAskAIFeedbackData, E as DocsAskAIFeedbackConfig, O as DocsAskAIFeedbackMessage, Q as DocsObservabilityConfig, W as DocsConfig, _ as DocsAgentTraceStatus, _t as DocsSearchQuery, a as ApiReferenceRenderer, at as DocsReviewRulesConfig, b as DocsAnalyticsEventInput, bt as DocsSearchSourcePage, dt as DocsSearchAdapterContext, et as DocsObservabilityEventInput, ft as DocsSearchAdapterFactory, g as DocsAgentTraceEventType, h as DocsAgentTraceEventInput, ht as DocsSearchDocument, it as DocsReviewConfig, jt as McpDocsSearchConfig, k as DocsAskAIFeedbackValue, mt as DocsSearchConfig, rt as DocsReviewCiMode, ut as DocsSearchAdapter, v as DocsAnalyticsConfig, vt as DocsSearchResult, xt as DocsSitemapConfig, y as DocsAnalyticsEvent } from "./types-BCEobEGw.mjs";
|
|
2
|
+
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, B as normalizePromptProviderName, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, F as DEFAULT_PROMPT_PROVIDER_TEMPLATES, G as serializeDocsIconRegistry, H as resolvePromptProviderChoices, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, K as serializeOpenDocsProvider, L as PromptProviderChoice, M as DEFAULT_OPEN_DOCS_PROMPT, N as DEFAULT_OPEN_DOCS_PROVIDER_IDS, O as resolveDocsSitemapConfig, P as DEFAULT_OPEN_DOCS_TARGET, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, U as sanitizePromptText, V as parsePromptStringArray, W as serializeDocsIcon, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as serializeOpenDocsProviders, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-D-iBv3VC.mjs";
|
|
3
3
|
import { DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/code-group-mdx.d.ts
|
|
@@ -2053,7 +2053,8 @@ type ApiReferenceRenderer = "fumadocs" | "scalar";
|
|
|
2053
2053
|
interface ApiReferenceConfig {
|
|
2054
2054
|
/**
|
|
2055
2055
|
* Whether to enable generated API reference pages.
|
|
2056
|
-
*
|
|
2056
|
+
* Supported adapters can generate references from framework route handlers
|
|
2057
|
+
* or a hosted OpenAPI JSON document.
|
|
2057
2058
|
* @default false
|
|
2058
2059
|
*/
|
|
2059
2060
|
enabled?: boolean;
|
|
@@ -2085,8 +2086,8 @@ interface ApiReferenceConfig {
|
|
|
2085
2086
|
/**
|
|
2086
2087
|
* Which renderer to use for the API reference UI.
|
|
2087
2088
|
*
|
|
2088
|
-
* - `"fumadocs"` uses
|
|
2089
|
-
* - `"scalar"` uses the
|
|
2089
|
+
* - `"fumadocs"` uses the Fumadocs OpenAPI renderer bundled by `@farming-labs/next`
|
|
2090
|
+
* - `"scalar"` uses the Scalar renderer bundled by `@farming-labs/docs` and the adapters
|
|
2090
2091
|
*
|
|
2091
2092
|
* Defaults are framework-aware:
|
|
2092
2093
|
* - Next.js: `"fumadocs"`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farming-labs/docs",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.23",
|
|
4
4
|
"description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"gray-matter": "^4.0.3",
|
|
45
45
|
"jiti": "^2.6.1",
|
|
46
46
|
"picocolors": "^1.1.1",
|
|
47
|
-
"zod": "^3.
|
|
47
|
+
"zod": "^4.3.6"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@types/node": "^22.10.0",
|