@farming-labs/docs 0.1.123 → 0.1.124
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/{agent-cmkIPvWo.mjs → agent-BtZrMCt8.mjs} +3 -3
- package/dist/agents-BPX4YRPs.mjs +209 -0
- package/dist/cli/index.mjs +31 -16
- package/dist/codeblocks-RacO12_K.mjs +1494 -0
- package/dist/{config-BHRL4R2v.mjs → config-B8wA38OC.mjs} +2 -2
- package/dist/{dev-C03tUSTz.mjs → dev-1VFeAWUi.mjs} +2 -2
- package/dist/{doctor-C9wz-4CE.mjs → doctor-B0nFg8oM.mjs} +3 -3
- package/dist/{downgrade-Bv7E5LV2.mjs → downgrade-BGANzvQb.mjs} +1 -1
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +1 -1
- package/dist/{init-_HAuo5Dv.mjs → init-DzQWiVN1.mjs} +1 -1
- package/dist/{mcp-veym29Yc.mjs → mcp-BvERlrP_.mjs} +1 -1
- package/dist/mcp.d.mts +1 -1
- package/dist/mcp.mjs +68 -7
- package/dist/{reading-time-Io7iRZ7S.mjs → reading-time-HpTq-0VB.mjs} +1 -0
- package/dist/{review-DEG_UnxV.mjs → review-ClNDYRnn.mjs} +1 -1
- package/dist/{robots-BkRZN-56.mjs → robots-CNLiZCay.mjs} +1 -1
- package/dist/{search-HqdPzNb3.mjs → search-BjyDm30M.mjs} +1 -1
- package/dist/{search-XmPPiA0V.d.mts → search-mF8wT9LQ.d.mts} +1 -1
- package/dist/server.d.mts +2 -2
- package/dist/{sitemap-wtr3w_D2.mjs → sitemap-BdSdcAmS.mjs} +1 -1
- package/dist/{types-CLofDwjw.d.mts → types-hDUu4K7W.d.mts} +133 -1
- package/dist/{upgrade-DrOWQIKI.mjs → upgrade-C7DvvfTR.mjs} +1 -1
- package/package.json +2 -1
- package/dist/agents-B3kj54S3.mjs +0 -795
- /package/dist/{package-version-L4GZowaF.mjs → package-version-OrjpmqoR.mjs} +0 -0
- /package/dist/{templates-CakZBXK8.mjs → templates-CGaORZOY.mjs} +0 -0
|
@@ -270,7 +270,7 @@ function loadProjectEnv(rootDir) {
|
|
|
270
270
|
}
|
|
271
271
|
return env;
|
|
272
272
|
}
|
|
273
|
-
async function loadDocsConfigModule(rootDir, explicitPath) {
|
|
273
|
+
async function loadDocsConfigModule(rootDir, explicitPath, options = {}) {
|
|
274
274
|
const configPath = resolveDocsConfigPath(rootDir, explicitPath);
|
|
275
275
|
try {
|
|
276
276
|
const { createJiti } = await import("jiti");
|
|
@@ -286,7 +286,7 @@ async function loadDocsConfigModule(rootDir, explicitPath) {
|
|
|
286
286
|
config
|
|
287
287
|
};
|
|
288
288
|
} catch (error) {
|
|
289
|
-
if (process.env.NODE_ENV !== "test") {
|
|
289
|
+
if (!options.silent && process.env.NODE_ENV !== "test") {
|
|
290
290
|
const message = error instanceof Error ? error.message : String(error);
|
|
291
291
|
console.warn(`[docs] Could not evaluate ${configPath} as a module; falling back to static parsing. ${message}`);
|
|
292
292
|
}
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { i as detectPackageManagerFromLockfile } from "./utils-x5EtYWjC.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-CGaORZOY.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
|
6
6
|
import { spawn } from "node:child_process";
|
|
7
|
+
import os from "node:os";
|
|
7
8
|
import { fileURLToPath } from "node:url";
|
|
8
9
|
import { z } from "zod";
|
|
9
|
-
import os from "node:os";
|
|
10
10
|
|
|
11
11
|
//#region src/cli/dev-banner.ts
|
|
12
12
|
function createDevLogger() {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import "./reading-time-
|
|
1
|
+
import "./reading-time-HpTq-0VB.mjs";
|
|
2
2
|
import "./search-BL7o2rXk.mjs";
|
|
3
3
|
import { a as DEFAULT_SITEMAP_XML_ROUTE, d as resolveDocsSitemapConfig, i as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, r as DEFAULT_SITEMAP_MD_ROUTE } from "./sitemap-CMNj0Pt3.mjs";
|
|
4
4
|
import { T as buildDocsMcpEndpointCandidates, b as DEFAULT_SKILL_MD_ROUTE, c as DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, d as DEFAULT_LLMS_FULL_TXT_ROUTE, g as DEFAULT_MCP_PUBLIC_ROUTE, i as DEFAULT_AGENT_FEEDBACK_ROUTE, l as DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, m as DEFAULT_LLMS_TXT_ROUTE, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, t as DEFAULT_AGENTS_MD_ROUTE, v as DEFAULT_MCP_WELL_KNOWN_ROUTE, x as DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE } from "./agent-BS39vnhS.mjs";
|
|
@@ -6,9 +6,9 @@ import { a as analyzeDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, u as resolveD
|
|
|
6
6
|
import "./sitemap-server-BZHoJHqC.mjs";
|
|
7
7
|
import { createFilesystemDocsMcpSource, resolveDocsMcpConfig } from "./mcp.mjs";
|
|
8
8
|
import "./server.mjs";
|
|
9
|
-
import { a as loadProjectEnv, c as readNavTitle, d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsContentDir, r as extractTopLevelConfigObject, t as extractNestedObjectLiteral } from "./config-
|
|
9
|
+
import { a as loadProjectEnv, c as readNavTitle, d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsContentDir, r as extractTopLevelConfigObject, t as extractNestedObjectLiteral } from "./config-B8wA38OC.mjs";
|
|
10
10
|
import { t as detectFramework } from "./utils-x5EtYWjC.mjs";
|
|
11
|
-
import { n as inspectAgentCompactionState, o as scanDocsPageTargets } from "./
|
|
11
|
+
import { n as inspectAgentCompactionState, o as scanDocsPageTargets } from "./codeblocks-RacO12_K.mjs";
|
|
12
12
|
import { existsSync, lstatSync, readFileSync, readdirSync } from "node:fs";
|
|
13
13
|
import path from "node:path";
|
|
14
14
|
import { LATEST_PROTOCOL_VERSION } from "@modelcontextprotocol/sdk/types.js";
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { c as fileExists, o as exec, s as execOutput } from "./utils-x5EtYWjC.mjs";
|
|
2
|
-
import { a as getPackagesForFramework, c as resolveDocsPackageManager, l as validateUpgradeVersion, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework } from "./package-version-
|
|
2
|
+
import { a as getPackagesForFramework, c as resolveDocsPackageManager, l as validateUpgradeVersion, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework } from "./package-version-OrjpmqoR.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
|
|
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 DocsCloudAnalyticsOptions, 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 resolveDocsObservabilityConfig, 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, ot as createDocsCloudAnalytics, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as resolveDocsAnalyticsConfig, 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 DocsReviewRulesConfig, A as DocsCodeBlocksConfig, At as OpenDocsProviderId, B as DocsFeedbackValue, Bt as ResolvedDocsRelatedLink, C as DocsAskAIActionData, Ct as LlmsTxtMaxCharsMode, D as DocsAskAIFeedbackMessage, Dt as OpenDocsConfig, E as DocsAskAIFeedbackData, Et as OGConfig, F as DocsCodeBlocksValidateConfig, Ft as PageFrontmatter, G as DocsNav, Gt as SidebarNode, H as DocsMcpConfig, Ht as SidebarConfig, I as DocsCodeBlocksValidationMode, It as PageOpenGraph, J as DocsObservabilityEventInput, Jt as SimpleDocsSearchConfig, K as DocsObservabilityConfig, Kt as SidebarPageNode, L as DocsCodeBlocksValidationPolicy, Lt as PageSidebarFrontmatter, M as DocsCodeBlocksPlannerProvider, Mt as OpenGraphImage, N as DocsCodeBlocksRunnerConfig, Nt as OrderingItem, O as DocsAskAIFeedbackValue, Ot as OpenDocsProvider, P as DocsCodeBlocksRunnerProvider, Pt as PageActionsConfig, Q as DocsReviewConfig, Qt as UIConfig, R as DocsConfig, Rt as PageTwitter, S as DocsAnalyticsSource, St as LlmsTxtMaxCharsConfig, T as DocsAskAIFeedbackConfig, Tt as McpDocsSearchConfig, U as DocsMcpToolsConfig, Ut as SidebarFolderIndexBehavior, V as DocsI18nConfig, Vt as SidebarComponentProps, W as DocsMetadata, Wt as SidebarFolderNode, X as DocsReviewCiConfig, Xt as TypesenseDocsSearchConfig, Y as DocsRelatedItem, Yt as ThemeToggleConfig, Z as DocsReviewCiMode, Zt as TypographyConfig, _ as DocsAnalyticsConfig, _t as FeedbackConfig, a as ApiReferenceRenderer, at as DocsSearchAdapterContext, b as DocsAnalyticsEventType, bt as LastUpdatedConfig, c as ChangelogFrontmatter, ct as DocsSearchConfig, d as CustomDocsSearchConfig, dt as DocsSearchQuery, et as DocsReviewScoreConfig, f as DocsAgentFeedbackContext, ft as DocsSearchResult, g as DocsAgentTraceStatus, gt as DocsTheme, h as DocsAgentTraceEventType, ht as DocsSitemapConfig, i as ApiReferenceConfig, it as DocsSearchAdapter, j as DocsCodeBlocksPlannerConfig, jt as OpenDocsTarget, k as DocsAskAIMcpConfig, kt as OpenDocsProviderConfig, l as CodeBlockCopyData, lt as DocsSearchDocument, m as DocsAgentTraceEventInput, mt as DocsSearchSourcePage, n as AgentFeedbackConfig, nt as DocsRobotsConfig, o as BreadcrumbConfig, ot as DocsSearchAdapterFactory, p as DocsAgentFeedbackData, pt as DocsSearchResultType, q as DocsObservabilityEvent, qt as SidebarTree, r as AlgoliaDocsSearchConfig, rt as DocsRobotsRule, s as ChangelogConfig, st as DocsSearchChunkingConfig, t as AIConfig, tt as DocsReviewSeverity, u as CopyMarkdownConfig, ut as DocsSearchEmbeddingsConfig, v as DocsAnalyticsEvent, vt as FontStyle, w as DocsAskAIActionType, wt as LlmsTxtSectionConfig, x as DocsAnalyticsInput, xt as LlmsTxtConfig, y as DocsAnalyticsEventInput, yt as GithubConfig, z as DocsFeedbackData, zt as ReadingTimeConfig } from "./types-hDUu4K7W.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 DocsCloudAnalyticsOptions, 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 resolveDocsObservabilityConfig, 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, ot as createDocsCloudAnalytics, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as resolveDocsAnalyticsConfig, 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-mF8wT9LQ.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/define-docs.d.ts
|
|
@@ -668,4 +668,4 @@ declare function renderDocsRobotsGeneratedBlock(options?: DocsRobotsRenderOption
|
|
|
668
668
|
declare function upsertDocsRobotsGeneratedBlock(existing: string, block: string): string;
|
|
669
669
|
declare function analyzeDocsRobotsTxt(content: string, options?: DocsRobotsRenderOptions): DocsRobotsAnalysis;
|
|
670
670
|
//#endregion
|
|
671
|
-
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CustomDocsSearchConfig, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, type DocsAgentDiscoverySpecOptions, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudAnalyticsOptions, type DocsConfig, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownPage, type DocsMcpConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStructuredDataBreadcrumb, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRobotsAllowRoutes, hasDocsMarkdownSignatureAgent, hashGeneratedAgentContent, inferDocsAskAIPackageHints, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, validateDocsAgentFeedbackPayload };
|
|
671
|
+
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CustomDocsSearchConfig, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, type DocsAgentDiscoverySpecOptions, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudAnalyticsOptions, type DocsCodeBlocksConfig, type DocsCodeBlocksPlannerConfig, type DocsCodeBlocksPlannerProvider, type DocsCodeBlocksRunnerConfig, type DocsCodeBlocksRunnerProvider, type DocsCodeBlocksValidateConfig, type DocsCodeBlocksValidationMode, type DocsCodeBlocksValidationPolicy, type DocsConfig, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownPage, type DocsMcpConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStructuredDataBreadcrumb, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRobotsAllowRoutes, hasDocsMarkdownSignatureAgent, hashGeneratedAgentContent, inferDocsAskAIPackageHints, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, validateDocsAgentFeedbackPayload };
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as resolveDocsPath, i as resolveReadingTimeFromSource, l as renderDocsPageStructuredDataJson, m as resolveDocsLocale, n as resolvePageReadingTime, o as buildDocsPageStructuredData, p as resolveDocsI18n, r as resolveReadingTimeFromContent, s as buildPageOpenGraph, t as estimateReadingTimeMinutes, u as resolveDocsMetadataBaseUrl, v as deepMerge, y as resolveChangelogConfig } from "./reading-time-
|
|
1
|
+
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as resolveDocsPath, i as resolveReadingTimeFromSource, l as renderDocsPageStructuredDataJson, m as resolveDocsLocale, n as resolvePageReadingTime, o as buildDocsPageStructuredData, p as resolveDocsI18n, r as resolveReadingTimeFromContent, s as buildPageOpenGraph, t as estimateReadingTimeMinutes, u as resolveDocsMetadataBaseUrl, v as deepMerge, y as resolveChangelogConfig } from "./reading-time-HpTq-0VB.mjs";
|
|
2
2
|
import { A as resolveDocsAnalyticsConfig, C as resolveSidebarFolderIndexBehaviorForPath, D as emitDocsAgentTraceEvent, E as createDocsAgentTraceId, M as createDocsCloudAnalytics, O as emitDocsAnalyticsEvent, S as resolveSidebarFolderIndexBehavior, T as createDocsAgentTraceContext, _ as parseGeneratedAgentDocument, a as createMcpSearchAdapter, b as applySidebarFolderIndexBehavior, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, g as normalizeGeneratedAgentContent, h as hashGeneratedAgentContent, i as createCustomSearchAdapter, j as resolveDocsObservabilityConfig, k as emitDocsObservabilityEvent, l as inferDocsAskAIPackageHints, m as GENERATED_AGENT_PROVENANCE_VERSION, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, p as GENERATED_AGENT_PROVENANCE_MARKER, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, v as serializeGeneratedAgentDocument, w as DOCS_AGENT_TRACE_EVENT_TYPES, x as resolvePageSidebarFolderIndexBehavior, y as stripGeneratedAgentProvenance } from "./search-BL7o2rXk.mjs";
|
|
3
3
|
import { n as renderDocsRelatedMarkdownLines, t as normalizeDocsRelated } from "./related-BNj_NdHq.mjs";
|
|
4
4
|
import { a as DEFAULT_SITEMAP_XML_ROUTE, c as readDocsSitemapManifestFromContentMap, d as resolveDocsSitemapConfig, f as resolveDocsSitemapPageLastmod, i as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, l as renderDocsSitemapMarkdown, m as toDocsSitemapMarkdownUrl, n as DEFAULT_SITEMAP_MD_DOCS_ROUTE, o as buildDocsSitemapManifest, p as resolveDocsSitemapRequest, r as DEFAULT_SITEMAP_MD_ROUTE, s as createDocsSitemapResponse, t as DEFAULT_SITEMAP_MANIFEST_PATH, u as renderDocsSitemapXml } from "./sitemap-CMNj0Pt3.mjs";
|
|
@@ -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-x5EtYWjC.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-CGaORZOY.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
|
@@ -2,7 +2,7 @@ import "./search-BL7o2rXk.mjs";
|
|
|
2
2
|
import "./sitemap-server-BZHoJHqC.mjs";
|
|
3
3
|
import { createFilesystemDocsMcpSource, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
4
4
|
import "./server.mjs";
|
|
5
|
-
import { c as readNavTitle, f as resolveDocsConfigPath, n as extractObjectLiteral, o as readBooleanProperty, p as resolveDocsContentDir, u as readStringProperty } from "./config-
|
|
5
|
+
import { c as readNavTitle, f as resolveDocsConfigPath, n as extractObjectLiteral, o as readBooleanProperty, p as resolveDocsContentDir, u as readStringProperty } from "./config-B8wA38OC.mjs";
|
|
6
6
|
import { readFileSync } from "node:fs";
|
|
7
7
|
|
|
8
8
|
//#region src/cli/mcp.ts
|
package/dist/mcp.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { H as DocsMcpConfig, K as DocsObservabilityConfig, Nt as OrderingItem, _ as DocsAnalyticsConfig, ct as DocsSearchConfig, mt as DocsSearchSourcePage } from "./types-hDUu4K7W.mjs";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
|
|
4
4
|
//#region src/mcp.d.ts
|
package/dist/mcp.mjs
CHANGED
|
@@ -370,6 +370,42 @@ const DOCS_CONFIG_SCHEMA_OPTIONS = [
|
|
|
370
370
|
description: "Docs route where the API reference is rendered."
|
|
371
371
|
}]
|
|
372
372
|
},
|
|
373
|
+
{
|
|
374
|
+
path: "codeBlocks",
|
|
375
|
+
name: "codeBlocks",
|
|
376
|
+
type: "{ validate?: boolean | DocsCodeBlocksValidateConfig }",
|
|
377
|
+
default: false,
|
|
378
|
+
description: "Code block intelligence for MD/MDX fences, including execution planning and optional sandboxed validation.",
|
|
379
|
+
docs: "/docs/configuration#code-block-validation",
|
|
380
|
+
children: [
|
|
381
|
+
{
|
|
382
|
+
path: "codeBlocks.validate",
|
|
383
|
+
name: "validate",
|
|
384
|
+
type: "boolean | DocsCodeBlocksValidateConfig",
|
|
385
|
+
description: "Enable `docs codeblocks validate` for fenced code examples."
|
|
386
|
+
},
|
|
387
|
+
{
|
|
388
|
+
path: "codeBlocks.validate.planner",
|
|
389
|
+
name: "planner",
|
|
390
|
+
type: "\"metadata\" | \"openai\" | \"openai-compatible\" | \"cloud\" | DocsCodeBlocksPlannerConfig",
|
|
391
|
+
default: "metadata",
|
|
392
|
+
description: "Planner that turns code fence metadata into an execution plan. Use OpenAI-compatible providers when metadata alone is not enough."
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
path: "codeBlocks.validate.runner",
|
|
396
|
+
name: "runner",
|
|
397
|
+
type: "\"local\" | \"vercel-sandbox\" | \"cloud\" | DocsCodeBlocksRunnerConfig",
|
|
398
|
+
default: "local",
|
|
399
|
+
description: "Runner used to execute planned snippets. The Vercel Sandbox runner can work from `VERCEL_TOKEN` alone by auto-discovering an accessible project."
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
path: "codeBlocks.validate.env",
|
|
403
|
+
name: "env",
|
|
404
|
+
type: "Record<string, string>",
|
|
405
|
+
description: "Runtime env mapping, for example `{ OPENAI_API_KEY: \"OPENAI_TEST_API_KEY\" }`."
|
|
406
|
+
}
|
|
407
|
+
]
|
|
408
|
+
},
|
|
373
409
|
{
|
|
374
410
|
path: "sitemap",
|
|
375
411
|
name: "sitemap",
|
|
@@ -397,18 +433,20 @@ const DOCS_CONFIG_SCHEMA_OPTIONS = [
|
|
|
397
433
|
description: "Dynamic Open Graph image configuration."
|
|
398
434
|
}
|
|
399
435
|
];
|
|
400
|
-
const DOCS_CONFIG_SCHEMA_EXAMPLES = [
|
|
401
|
-
|
|
402
|
-
|
|
436
|
+
const DOCS_CONFIG_SCHEMA_EXAMPLES = [
|
|
437
|
+
{
|
|
438
|
+
title: "Minimal config",
|
|
439
|
+
code: `import { defineDocs } from "@farming-labs/docs";
|
|
403
440
|
import { fumadocs } from "@farming-labs/theme";
|
|
404
441
|
|
|
405
442
|
export default defineDocs({
|
|
406
443
|
entry: "docs",
|
|
407
444
|
theme: fumadocs(),
|
|
408
445
|
});`
|
|
409
|
-
},
|
|
410
|
-
|
|
411
|
-
|
|
446
|
+
},
|
|
447
|
+
{
|
|
448
|
+
title: "MCP tool toggles",
|
|
449
|
+
code: `export default defineDocs({
|
|
412
450
|
entry: "docs",
|
|
413
451
|
mcp: {
|
|
414
452
|
tools: {
|
|
@@ -418,7 +456,30 @@ export default defineDocs({
|
|
|
418
456
|
},
|
|
419
457
|
},
|
|
420
458
|
});`
|
|
421
|
-
}
|
|
459
|
+
},
|
|
460
|
+
{
|
|
461
|
+
title: "Code block validation",
|
|
462
|
+
code: `export default defineDocs({
|
|
463
|
+
entry: "docs",
|
|
464
|
+
codeBlocks: {
|
|
465
|
+
validate: {
|
|
466
|
+
planner: {
|
|
467
|
+
provider: "openai",
|
|
468
|
+
model: "gpt-4.1-mini",
|
|
469
|
+
apiKeyEnv: "OPENAI_API_KEY",
|
|
470
|
+
},
|
|
471
|
+
runner: {
|
|
472
|
+
provider: "vercel-sandbox",
|
|
473
|
+
tokenEnv: "VERCEL_TOKEN",
|
|
474
|
+
},
|
|
475
|
+
env: {
|
|
476
|
+
OPENAI_API_KEY: "OPENAI_TEST_API_KEY",
|
|
477
|
+
},
|
|
478
|
+
},
|
|
479
|
+
},
|
|
480
|
+
});`
|
|
481
|
+
}
|
|
482
|
+
];
|
|
422
483
|
const searchDocsInputSchema = z.object({
|
|
423
484
|
query: z.string().trim().min(1),
|
|
424
485
|
limit: z.number().int().min(1).max(25).optional(),
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-B7goPYUb.mjs";
|
|
2
|
-
import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, p as resolveDocsContentDir } from "./config-
|
|
2
|
+
import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, p as resolveDocsContentDir } from "./config-B8wA38OC.mjs";
|
|
3
3
|
import matter from "gray-matter";
|
|
4
4
|
import { existsSync, lstatSync, readFileSync, readdirSync } from "node:fs";
|
|
5
5
|
import path from "node:path";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import "./agent-BS39vnhS.mjs";
|
|
2
2
|
import { c as renderDocsRobotsGeneratedBlock, f as upsertDocsRobotsGeneratedBlock, i as DOCS_ROBOTS_GENERATED_BLOCK_START, r as DOCS_ROBOTS_GENERATED_BLOCK_END, u as resolveDocsRobotsConfig } from "./robots-B2BfoyVM.mjs";
|
|
3
|
-
import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-
|
|
3
|
+
import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-B8wA38OC.mjs";
|
|
4
4
|
import { t as detectFramework } from "./utils-x5EtYWjC.mjs";
|
|
5
5
|
import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
|
|
6
6
|
import path from "node:path";
|
|
@@ -2,7 +2,7 @@ import { n as buildDocsSearchDocuments, r as createAlgoliaSearchAdapter, s as cr
|
|
|
2
2
|
import "./sitemap-server-BZHoJHqC.mjs";
|
|
3
3
|
import { createFilesystemDocsMcpSource } from "./mcp.mjs";
|
|
4
4
|
import "./server.mjs";
|
|
5
|
-
import { a as loadProjectEnv, d as readTopLevelStringProperty, f as resolveDocsConfigPath, p as resolveDocsContentDir } from "./config-
|
|
5
|
+
import { a as loadProjectEnv, d as readTopLevelStringProperty, f as resolveDocsConfigPath, p as resolveDocsContentDir } from "./config-B8wA38OC.mjs";
|
|
6
6
|
import { readFileSync } from "node:fs";
|
|
7
7
|
import pc from "picocolors";
|
|
8
8
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Bt as ResolvedDocsRelatedLink, J as DocsObservabilityEventInput, K as DocsObservabilityConfig, Ot as OpenDocsProvider, Tt as McpDocsSearchConfig, Xt as TypesenseDocsSearchConfig, _ as DocsAnalyticsConfig, ct as DocsSearchConfig, d as CustomDocsSearchConfig, ft as DocsSearchResult, ht as DocsSitemapConfig, it as DocsSearchAdapter, jt as OpenDocsTarget, k as DocsAskAIMcpConfig, lt as DocsSearchDocument, m as DocsAgentTraceEventInput, mt as DocsSearchSourcePage, ot as DocsSearchAdapterFactory, q as DocsObservabilityEvent, r as AlgoliaDocsSearchConfig, st as DocsSearchChunkingConfig, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput } from "./types-hDUu4K7W.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/cloud-analytics.d.ts
|
|
4
4
|
interface DocsCloudAnalyticsOptions {
|
package/dist/server.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
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 DocsCloudAnalyticsOptions, 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 resolveDocsObservabilityConfig, 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, ot as createDocsCloudAnalytics, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as serializeOpenDocsProviders, r as createAlgoliaSearchAdapter, rt as resolveDocsAnalyticsConfig, 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 DocsReviewRulesConfig, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, J as DocsObservabilityEventInput, K as DocsObservabilityConfig, O as DocsAskAIFeedbackValue, Q as DocsReviewConfig, R as DocsConfig, T as DocsAskAIFeedbackConfig, Tt as McpDocsSearchConfig, Z as DocsReviewCiMode, _ as DocsAnalyticsConfig, a as ApiReferenceRenderer, at as DocsSearchAdapterContext, ct as DocsSearchConfig, dt as DocsSearchQuery, ft as DocsSearchResult, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, ht as DocsSitemapConfig, it as DocsSearchAdapter, k as DocsAskAIMcpConfig, lt as DocsSearchDocument, m as DocsAgentTraceEventInput, mt as DocsSearchSourcePage, ot as DocsSearchAdapterFactory, q as DocsObservabilityEvent, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput } from "./types-hDUu4K7W.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 DocsCloudAnalyticsOptions, 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 resolveDocsObservabilityConfig, 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, ot as createDocsCloudAnalytics, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as serializeOpenDocsProviders, r as createAlgoliaSearchAdapter, rt as resolveDocsAnalyticsConfig, 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-mF8wT9LQ.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/api-reference.d.ts
|
|
@@ -3,7 +3,7 @@ import { d as resolveDocsSitemapConfig, l as renderDocsSitemapMarkdown, o as bui
|
|
|
3
3
|
import "./sitemap-server-BZHoJHqC.mjs";
|
|
4
4
|
import { createFilesystemDocsMcpSource } from "./mcp.mjs";
|
|
5
5
|
import "./server.mjs";
|
|
6
|
-
import { c as readNavTitle, d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsContentDir, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-
|
|
6
|
+
import { c as readNavTitle, d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsContentDir, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-B8wA38OC.mjs";
|
|
7
7
|
import { t as detectFramework } from "./utils-x5EtYWjC.mjs";
|
|
8
8
|
import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from "node:fs";
|
|
9
9
|
import path from "node:path";
|
|
@@ -2120,6 +2120,133 @@ interface DocsReviewConfig {
|
|
|
2120
2120
|
/** Optional rule severity overrides. */
|
|
2121
2121
|
rules?: DocsReviewRulesConfig;
|
|
2122
2122
|
}
|
|
2123
|
+
type DocsCodeBlocksPlannerProvider = "metadata" | "openai" | "openai-compatible" | "cloud";
|
|
2124
|
+
type DocsCodeBlocksRunnerProvider = "local" | "vercel-sandbox" | "cloud";
|
|
2125
|
+
type DocsCodeBlocksValidationMode = "plan" | "report";
|
|
2126
|
+
type DocsCodeBlocksValidationPolicy = "skip" | "warn" | "error";
|
|
2127
|
+
interface DocsCodeBlocksPlannerConfig {
|
|
2128
|
+
/**
|
|
2129
|
+
* Planner used to turn code fence metadata into an execution plan.
|
|
2130
|
+
*
|
|
2131
|
+
* - `"metadata"` reads the fence language and metadata locally.
|
|
2132
|
+
* - `"openai"` calls OpenAI's chat completions API.
|
|
2133
|
+
* - `"openai-compatible"` calls an OpenAI-compatible chat completions endpoint.
|
|
2134
|
+
* - `"cloud"` is reserved for the hosted Farming Labs planner.
|
|
2135
|
+
*
|
|
2136
|
+
* @default "metadata"
|
|
2137
|
+
*/
|
|
2138
|
+
provider?: DocsCodeBlocksPlannerProvider;
|
|
2139
|
+
/** Model name for LLM-backed planners. */
|
|
2140
|
+
model?: string;
|
|
2141
|
+
/** OpenAI-compatible base URL. Defaults to `https://api.openai.com/v1` for `provider: "openai"`. */
|
|
2142
|
+
baseUrl?: string;
|
|
2143
|
+
/** Environment variable containing the OpenAI-compatible base URL. */
|
|
2144
|
+
baseUrlEnv?: string;
|
|
2145
|
+
/** API key value. Prefer `apiKeyEnv` so secrets stay out of docs.config. */
|
|
2146
|
+
apiKey?: string;
|
|
2147
|
+
/** Environment variable containing the planner API key. */
|
|
2148
|
+
apiKeyEnv?: string;
|
|
2149
|
+
}
|
|
2150
|
+
interface DocsCodeBlocksRunnerConfig {
|
|
2151
|
+
/**
|
|
2152
|
+
* Runner used to execute planned code blocks.
|
|
2153
|
+
*
|
|
2154
|
+
* @default "local"
|
|
2155
|
+
*/
|
|
2156
|
+
provider?: DocsCodeBlocksRunnerProvider;
|
|
2157
|
+
/** Environment variable containing the Vercel token for `provider: "vercel-sandbox"`. */
|
|
2158
|
+
tokenEnv?: string;
|
|
2159
|
+
/** Advanced override for the Vercel project id env var used by `provider: "vercel-sandbox"`. */
|
|
2160
|
+
projectIdEnv?: string;
|
|
2161
|
+
/** Advanced override for the Vercel team/org id env var used by `provider: "vercel-sandbox"`. */
|
|
2162
|
+
teamIdEnv?: string;
|
|
2163
|
+
/**
|
|
2164
|
+
* Path to a Vercel project metadata file. When enabled, the runner reads
|
|
2165
|
+
* `projectId` and `orgId` from `.vercel/project.json`. If those are not
|
|
2166
|
+
* available, the runner can auto-discover an accessible project from
|
|
2167
|
+
* `VERCEL_TOKEN`.
|
|
2168
|
+
*
|
|
2169
|
+
* @default ".vercel/project.json"
|
|
2170
|
+
*/
|
|
2171
|
+
projectJson?: string | false;
|
|
2172
|
+
/** Vercel Sandbox runtime. */
|
|
2173
|
+
runtime?: "node24" | "node22" | "python3.13";
|
|
2174
|
+
/** Per-command timeout in milliseconds. */
|
|
2175
|
+
timeoutMs?: number;
|
|
2176
|
+
}
|
|
2177
|
+
interface DocsCodeBlocksValidateConfig {
|
|
2178
|
+
/**
|
|
2179
|
+
* Enable code block validation.
|
|
2180
|
+
*
|
|
2181
|
+
* @default true when `codeBlocks.validate` is an object or `true`
|
|
2182
|
+
*/
|
|
2183
|
+
enabled?: boolean;
|
|
2184
|
+
/** Planner config. Use `"metadata"` for local deterministic planning. */
|
|
2185
|
+
planner?: DocsCodeBlocksPlannerProvider | DocsCodeBlocksPlannerConfig;
|
|
2186
|
+
/** Runner config. Use `"vercel-sandbox"` for isolated runtime checks. */
|
|
2187
|
+
runner?: DocsCodeBlocksRunnerProvider | DocsCodeBlocksRunnerConfig;
|
|
2188
|
+
/**
|
|
2189
|
+
* Env files loaded for validation. These are read locally and never committed.
|
|
2190
|
+
*
|
|
2191
|
+
* @default [".env.local", ".env.test", ".env"]
|
|
2192
|
+
*/
|
|
2193
|
+
envFile?: string | string[];
|
|
2194
|
+
/**
|
|
2195
|
+
* Runtime env mapping.
|
|
2196
|
+
*
|
|
2197
|
+
* The key is the env var used by the docs code block. The value is the local
|
|
2198
|
+
* env var to read from. For example, `{ OPENAI_API_KEY: "OPENAI_TEST_API_KEY" }`
|
|
2199
|
+
* injects `OPENAI_API_KEY` into the runner from `OPENAI_TEST_API_KEY`.
|
|
2200
|
+
*/
|
|
2201
|
+
env?: Record<string, string>;
|
|
2202
|
+
/**
|
|
2203
|
+
* Behavior when a runnable block declares an env var that cannot be resolved.
|
|
2204
|
+
*
|
|
2205
|
+
* @default "skip"
|
|
2206
|
+
*/
|
|
2207
|
+
missingEnv?: DocsCodeBlocksValidationPolicy;
|
|
2208
|
+
/**
|
|
2209
|
+
* Behavior when a language cannot be executed by the selected runner.
|
|
2210
|
+
*
|
|
2211
|
+
* @default "skip"
|
|
2212
|
+
*/
|
|
2213
|
+
unsupportedLanguage?: DocsCodeBlocksValidationPolicy;
|
|
2214
|
+
/**
|
|
2215
|
+
* Default command mode.
|
|
2216
|
+
*
|
|
2217
|
+
* - `"plan"` builds execution plans without running them.
|
|
2218
|
+
* - `"report"` runs executable plans and reports pass/skip/fail.
|
|
2219
|
+
*
|
|
2220
|
+
* @default "report"
|
|
2221
|
+
*/
|
|
2222
|
+
mode?: DocsCodeBlocksValidationMode;
|
|
2223
|
+
}
|
|
2224
|
+
interface DocsCodeBlocksConfig {
|
|
2225
|
+
/**
|
|
2226
|
+
* Validate fenced code blocks from MD/MDX docs.
|
|
2227
|
+
*
|
|
2228
|
+
* @example
|
|
2229
|
+
* ```ts
|
|
2230
|
+
* codeBlocks: {
|
|
2231
|
+
* validate: {
|
|
2232
|
+
* planner: {
|
|
2233
|
+
* provider: "openai",
|
|
2234
|
+
* model: "gpt-4.1-mini",
|
|
2235
|
+
* apiKeyEnv: "OPENAI_API_KEY",
|
|
2236
|
+
* },
|
|
2237
|
+
* runner: {
|
|
2238
|
+
* provider: "vercel-sandbox",
|
|
2239
|
+
* tokenEnv: "VERCEL_TOKEN",
|
|
2240
|
+
* },
|
|
2241
|
+
* env: {
|
|
2242
|
+
* OPENAI_API_KEY: "OPENAI_TEST_API_KEY",
|
|
2243
|
+
* },
|
|
2244
|
+
* },
|
|
2245
|
+
* }
|
|
2246
|
+
* ```
|
|
2247
|
+
*/
|
|
2248
|
+
validate?: boolean | DocsCodeBlocksValidateConfig;
|
|
2249
|
+
}
|
|
2123
2250
|
interface DocsConfig {
|
|
2124
2251
|
/** Entry folder for docs (e.g. "docs" → /docs) */
|
|
2125
2252
|
entry: string;
|
|
@@ -2271,6 +2398,11 @@ interface DocsConfig {
|
|
|
2271
2398
|
* ```
|
|
2272
2399
|
*/
|
|
2273
2400
|
onCopyClick?: (data: CodeBlockCopyData) => void;
|
|
2401
|
+
/**
|
|
2402
|
+
* Code block intelligence for MD/MDX fences, including validation planning
|
|
2403
|
+
* and optional sandboxed execution.
|
|
2404
|
+
*/
|
|
2405
|
+
codeBlocks?: DocsCodeBlocksConfig;
|
|
2274
2406
|
/**
|
|
2275
2407
|
* Built-in page feedback prompt shown at the end of a docs page.
|
|
2276
2408
|
*
|
|
@@ -2586,4 +2718,4 @@ interface DocsConfig {
|
|
|
2586
2718
|
og?: OGConfig;
|
|
2587
2719
|
}
|
|
2588
2720
|
//#endregion
|
|
2589
|
-
export {
|
|
2721
|
+
export { DocsReviewRulesConfig as $, DocsCodeBlocksConfig as A, OpenDocsProviderId as At, DocsFeedbackValue as B, ResolvedDocsRelatedLink as Bt, DocsAskAIActionData as C, LlmsTxtMaxCharsMode as Ct, DocsAskAIFeedbackMessage as D, OpenDocsConfig as Dt, DocsAskAIFeedbackData as E, OGConfig as Et, DocsCodeBlocksValidateConfig as F, PageFrontmatter as Ft, DocsNav as G, SidebarNode as Gt, DocsMcpConfig as H, SidebarConfig as Ht, DocsCodeBlocksValidationMode as I, PageOpenGraph as It, DocsObservabilityEventInput as J, SimpleDocsSearchConfig as Jt, DocsObservabilityConfig as K, SidebarPageNode as Kt, DocsCodeBlocksValidationPolicy as L, PageSidebarFrontmatter as Lt, DocsCodeBlocksPlannerProvider as M, OpenGraphImage as Mt, DocsCodeBlocksRunnerConfig as N, OrderingItem as Nt, DocsAskAIFeedbackValue as O, OpenDocsProvider as Ot, DocsCodeBlocksRunnerProvider as P, PageActionsConfig as Pt, DocsReviewConfig as Q, UIConfig as Qt, DocsConfig as R, PageTwitter as Rt, DocsAnalyticsSource as S, LlmsTxtMaxCharsConfig as St, DocsAskAIFeedbackConfig as T, McpDocsSearchConfig as Tt, DocsMcpToolsConfig as U, SidebarFolderIndexBehavior as Ut, DocsI18nConfig as V, SidebarComponentProps as Vt, DocsMetadata as W, SidebarFolderNode as Wt, DocsReviewCiConfig as X, TypesenseDocsSearchConfig as Xt, DocsRelatedItem as Y, ThemeToggleConfig as Yt, DocsReviewCiMode as Z, TypographyConfig as Zt, DocsAnalyticsConfig as _, FeedbackConfig as _t, ApiReferenceRenderer as a, DocsSearchAdapterContext as at, DocsAnalyticsEventType as b, LastUpdatedConfig as bt, ChangelogFrontmatter as c, DocsSearchConfig as ct, CustomDocsSearchConfig as d, DocsSearchQuery as dt, DocsReviewScoreConfig as et, DocsAgentFeedbackContext as f, DocsSearchResult as ft, DocsAgentTraceStatus as g, DocsTheme as gt, DocsAgentTraceEventType as h, DocsSitemapConfig as ht, ApiReferenceConfig as i, DocsSearchAdapter as it, DocsCodeBlocksPlannerConfig as j, OpenDocsTarget as jt, DocsAskAIMcpConfig as k, OpenDocsProviderConfig as kt, CodeBlockCopyData as l, DocsSearchDocument as lt, DocsAgentTraceEventInput as m, DocsSearchSourcePage as mt, AgentFeedbackConfig as n, DocsRobotsConfig as nt, BreadcrumbConfig as o, DocsSearchAdapterFactory as ot, DocsAgentFeedbackData as p, DocsSearchResultType as pt, DocsObservabilityEvent as q, SidebarTree as qt, AlgoliaDocsSearchConfig as r, DocsRobotsRule as rt, ChangelogConfig as s, DocsSearchChunkingConfig as st, AIConfig as t, DocsReviewSeverity as tt, CopyMarkdownConfig as u, DocsSearchEmbeddingsConfig as ut, DocsAnalyticsEvent as v, FontStyle as vt, DocsAskAIActionType as w, LlmsTxtSectionConfig as wt, DocsAnalyticsInput as x, LlmsTxtConfig as xt, DocsAnalyticsEventInput as y, GithubConfig as yt, DocsFeedbackData as z, ReadingTimeConfig as zt };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { c as fileExists, o as exec } from "./utils-x5EtYWjC.mjs";
|
|
2
|
-
import { a as getPackagesForFramework, c as resolveDocsPackageManager, i as frameworkFromPreset, l as validateUpgradeVersion, n as PRESETS, o as presetFromFramework, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework, t as PACKAGES_BY_FRAMEWORK } from "./package-version-
|
|
2
|
+
import { a as getPackagesForFramework, c as resolveDocsPackageManager, i as frameworkFromPreset, l as validateUpgradeVersion, n as PRESETS, o as presetFromFramework, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework, t as PACKAGES_BY_FRAMEWORK } from "./package-version-OrjpmqoR.mjs";
|
|
3
3
|
import path from "node:path";
|
|
4
4
|
import pc from "picocolors";
|
|
5
5
|
import * as p from "@clack/prompts";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farming-labs/docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.124",
|
|
4
4
|
"description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs",
|
|
@@ -40,6 +40,7 @@
|
|
|
40
40
|
"@clack/prompts": "^0.9.1",
|
|
41
41
|
"@modelcontextprotocol/sdk": "1.29.0",
|
|
42
42
|
"@scalar/core": "^0.4.3",
|
|
43
|
+
"@vercel/sandbox": "^2.0.0",
|
|
43
44
|
"gray-matter": "^4.0.3",
|
|
44
45
|
"jiti": "^2.6.1",
|
|
45
46
|
"picocolors": "^1.1.1",
|