@farming-labs/docs 0.2.120 → 0.2.122
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/README.md +8 -0
- package/dist/access.d.mts +13 -0
- package/dist/access.mjs +56 -0
- package/dist/agent-conformance.d.mts +60 -0
- package/dist/agent-conformance.mjs +538 -0
- package/dist/agent-contract.d.mts +47 -0
- package/dist/agent-contract.mjs +645 -0
- package/dist/agent-detection.d.mts +6 -0
- package/dist/agent-detection.mjs +83 -0
- package/dist/agent-evals.d.mts +224 -0
- package/dist/{agent-evals-BLNLvXbG.mjs → agent-evals.mjs} +7 -565
- package/dist/agent-feedback-evaluations-node.mjs +38 -0
- package/dist/agent-feedback-evaluations.d.mts +91 -0
- package/dist/{agent-feedback-evaluations-CcMGlgsO.mjs → agent-feedback-evaluations.mjs} +2 -2
- package/dist/agent-feedback-loop.d.mts +45 -0
- package/dist/{agent-feedback-loop-CcZL_sb1.mjs → agent-feedback-loop.mjs} +1 -1
- package/dist/agent-maintenance.d.mts +71 -0
- package/dist/{agent-maintenance-CuZ7iAKq.mjs → agent-maintenance.mjs} +1 -1
- package/dist/agent-provenance.d.mts +23 -0
- package/dist/agent-provenance.mjs +77 -0
- package/dist/agent-scope.mjs +321 -0
- package/dist/agent-skills-archive.mjs +86 -0
- package/dist/agent-skills-bundle.d.mts +1 -1
- package/dist/{agent-skills-progressive-disclosure-PjPtTYL-.mjs → agent-skills-progressive-disclosure.mjs} +2 -2
- package/dist/{agent-skills-server-D5IuvwM7.d.mts → agent-skills-server.d.mts} +3 -3
- package/dist/{agent-skills-server-BC7md56k.mjs → agent-skills-server.mjs} +2 -2
- package/dist/agent-skills-vite.d.mts +3 -3
- package/dist/agent-skills-vite.mjs +1 -2
- package/dist/agent-surface-drift.mjs +236 -0
- package/dist/{golden-evaluations-CLUViycJ.mjs → agent-usefulness.mjs} +5 -290
- package/dist/{content-change-hydration-wqXIZHp6.d.mts → agent.d.mts} +10 -411
- package/dist/agent.mjs +2729 -0
- package/dist/{analytics-w3FDOksr.d.mts → analytics.d.mts} +2 -2
- package/dist/{analytics-p8Vhhu2P.mjs → analytics.mjs} +2 -2
- package/dist/{sitemap-server-BUdPBcGs.d.mts → api-reference.d.mts} +2 -6
- package/dist/api-reference.mjs +1481 -0
- package/dist/{audience-exposure-DBrFWULA.d.mts → audience-exposure.d.mts} +1 -1
- package/dist/audience-exposure.mjs +8 -0
- package/dist/audience.d.mts +44 -0
- package/dist/audience.mjs +1654 -0
- package/dist/authoring-mcp.d.mts +44 -0
- package/dist/{authoring-mcp-CiCUQe3o.mjs → authoring-mcp.mjs} +3 -3
- package/dist/browser.d.mts +6 -4
- package/dist/browser.mjs +6 -7
- package/dist/build.d.mts +8 -0
- package/dist/build.mjs +8 -0
- package/dist/changelog.d.mts +20 -0
- package/dist/changelog.mjs +39 -0
- package/dist/{agent-export-CA6IUQ7T.mjs → cli/agent-export.mjs} +19 -45
- package/dist/{agent-CYk2DxY7.mjs → cli/agent.mjs} +6 -35
- package/dist/{agents-BUiVmj8i.mjs → cli/agents.mjs} +5 -18
- package/dist/cli/api-doctor.mjs +206 -0
- package/dist/{authoring-C2ymvYWl.mjs → cli/authoring.mjs} +2 -8
- package/dist/{cloud-6eKrlmKd.mjs → cli/cloud.mjs} +3 -3
- package/dist/{codeblocks-CHpgAwY-.mjs → cli/codeblocks.mjs} +2 -2
- package/dist/cli/config.d.mts +11 -0
- package/dist/{config-BZnKAj_Y.mjs → cli/config.mjs} +1 -1
- package/dist/cli/dev-banner.mjs +58 -0
- package/dist/{dev-Bnn-NUNa.mjs → cli/dev.mjs} +3 -57
- package/dist/{doctor-Bfkrkzad.mjs → cli/doctor.mjs} +41 -226
- package/dist/{downgrade-CHMta85e.mjs → cli/downgrade.mjs} +2 -2
- package/dist/cli/errors.d.mts +4 -0
- package/dist/{errors-BtnVLhNF.mjs → cli/errors.mjs} +1 -1
- package/dist/{feedback-evals-DMilg9pY.mjs → cli/feedback-evals.mjs} +3 -36
- package/dist/{feedback-DL4T5oIO.mjs → cli/feedback.mjs} +1 -1
- package/dist/cli/git-dates.mjs +35 -0
- package/dist/cli/golden-evaluations.mjs +52 -0
- package/dist/cli/index.d.mts +2 -3
- package/dist/cli/index.mjs +38 -38
- package/dist/{init-K0LmXDZ5.mjs → cli/init.mjs} +3 -3
- package/dist/{mcp-iLCmnPJI.mjs → cli/mcp.mjs} +7 -19
- package/dist/{openapi-diff-HcpUNjA-.mjs → cli/openapi-diff.mjs} +2 -7
- package/dist/{openapi-sdk-BQKC6H-_.mjs → cli/openapi-sdk.mjs} +2 -7
- package/dist/{openapi-source-DK6ts_Bk.mjs → cli/openapi-source.mjs} +2 -2
- package/dist/{package-version-HJhYeq4M.mjs → cli/package-version.mjs} +2 -2
- package/dist/{propose-JmUv_BTt.mjs → cli/propose.mjs} +1 -1
- package/dist/{review-C6EmbV0l.mjs → cli/review.mjs} +16 -15
- package/dist/{robots-DteZB8vl.mjs → cli/robots.mjs} +3 -7
- package/dist/{search-Bhuv_YsL.mjs → cli/search.mjs} +7 -20
- package/dist/{sitemap-DW5LDKDa.mjs → cli/sitemap.mjs} +7 -42
- package/dist/{skills-BAPQLSCm.mjs → cli/skills.mjs} +5 -19
- package/dist/{templates-BuQ8YsGv.mjs → cli/templates.mjs} +1 -1
- package/dist/{upgrade-DlQMOFV1.mjs → cli/upgrade.mjs} +2 -2
- package/dist/{utils-C7KDrPpA.mjs → cli/utils.mjs} +1 -1
- package/dist/client/react.d.mts +2 -18
- package/dist/client/react.mjs +1 -157
- package/dist/{cloud-analytics-D14HplI7.mjs → cloud-analytics.mjs} +1 -1
- package/dist/{cloud-ask-ai-BrsTXQf6.d.mts → cloud-ask-ai.d.mts} +2 -2
- package/dist/{cloud-ask-ai-BqKhjpS5.mjs → cloud-ask-ai.mjs} +3 -3
- package/dist/code-blocks.d.mts +51 -0
- package/dist/{code-blocks-GYdvS3BH.mjs → code-blocks.mjs} +2 -2
- package/dist/code-group-mdx.d.mts +11 -0
- package/dist/code-group-mdx.mjs +57 -0
- package/dist/content-change-hydration.d.mts +87 -0
- package/dist/{openapi-mcp-BIOTLiA7.mjs → content-change-hydration.mjs} +5 -210
- package/dist/content-changes.d.mts +47 -0
- package/dist/content-changes.mjs +216 -0
- package/dist/create-theme.d.mts +48 -0
- package/dist/create-theme.mjs +57 -0
- package/dist/date.d.mts +5 -0
- package/dist/date.mjs +17 -0
- package/dist/define-docs.d.mts +9 -0
- package/dist/define-docs.mjs +46 -0
- package/dist/docs-cloud-client.d.mts +18 -0
- package/dist/docs-cloud-client.mjs +161 -0
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/docs-cloud-server.mjs +2 -3
- package/dist/heading-toc.d.mts +10 -0
- package/dist/heading-toc.mjs +23 -0
- package/dist/http-body.d.mts +14 -0
- package/dist/{http-body-DkAPk6D5.mjs → http-body.mjs} +1 -1
- package/dist/http-cache.d.mts +25 -0
- package/dist/http-cache.mjs +140 -0
- package/dist/http-link.mjs +81 -0
- package/dist/i18n.d.mts +18 -0
- package/dist/{i18n-B1gJ9EW0.mjs → i18n.mjs} +1 -1
- package/dist/index.d.mts +42 -674
- package/dist/index.mjs +40 -14
- package/dist/markdown-rendering.mjs +1 -1
- package/dist/markdown-section-cache.mjs +49 -0
- package/dist/markdown-sections.d.mts +47 -0
- package/dist/{markdown-sections-9Oxr33b-.mjs → markdown-sections.mjs} +29 -703
- package/dist/mcp-auth.d.mts +14 -0
- package/dist/mcp-auth.mjs +99 -0
- package/dist/mcp.d.mts +5 -3
- package/dist/mcp.mjs +21 -9
- package/dist/mdx.d.mts +6 -0
- package/dist/mdx.mjs +7 -0
- package/dist/metadata.d.mts +60 -0
- package/dist/{metadata-BOHn0Y5K.mjs → metadata.mjs} +2 -2
- package/dist/native-api-reference.mjs +968 -0
- package/dist/okf.d.mts +42 -0
- package/dist/okf.mjs +145 -0
- package/dist/openapi-contract.mjs +154 -0
- package/dist/{openapi-mcp-node-C4jUpZG6.mjs → openapi-mcp-node.mjs} +1 -1
- package/dist/openapi-mcp.d.mts +26 -0
- package/dist/openapi-mcp.mjs +132 -0
- package/dist/openapi-operations.d.mts +71 -0
- package/dist/{openapi-operations-DFpaqOqA.mjs → openapi-operations.mjs} +1 -1
- package/dist/openapi-overlays.mjs +221 -0
- package/dist/openapi-references.mjs +233 -0
- package/dist/pagination.d.mts +7 -0
- package/dist/pagination.mjs +100 -0
- package/dist/prompt-references.d.mts +12 -0
- package/dist/prompt-references.mjs +132 -0
- package/dist/prompt-utils.d.mts +36 -0
- package/dist/{prompt-utils-B5g-bv7o.mjs → prompt-utils.mjs} +1 -57
- package/dist/reading-time.d.mts +23 -0
- package/dist/reading-time.mjs +58 -0
- package/dist/related.d.mts +7 -0
- package/dist/related.mjs +50 -0
- package/dist/retrieval-digest.d.mts +16 -0
- package/dist/{retrieval-digest-CT-eIEcp.mjs → retrieval-digest.mjs} +1 -1
- package/dist/review.d.mts +69 -0
- package/dist/review.mjs +562 -0
- package/dist/robots.d.mts +54 -0
- package/dist/{robots-BYJAVeI6.mjs → robots.mjs} +5 -3
- package/dist/runtime.d.mts +3 -3
- package/dist/runtime.mjs +3 -9
- package/dist/search.d.mts +210 -0
- package/dist/search.mjs +3401 -0
- package/dist/server.d.mts +22 -198
- package/dist/server.mjs +21 -19
- package/dist/sidebar.d.mts +15 -0
- package/dist/sidebar.mjs +73 -0
- package/dist/sitemap-server.d.mts +7 -0
- package/dist/{sitemap-server-Lg3YhUx4.mjs → sitemap-server.mjs} +2 -2
- package/dist/{sitemap-Cl8vrixd.d.mts → sitemap.d.mts} +3 -3
- package/dist/sitemap.mjs +254 -0
- package/dist/{standards-discovery-BHPc7YIX.d.mts → standards-discovery.d.mts} +2 -2
- package/dist/{standards-discovery-sSEojU80.mjs → standards-discovery.mjs} +3 -139
- package/dist/telemetry-runtime.d.mts +42 -0
- package/dist/telemetry-runtime.mjs +238 -0
- package/dist/telemetry.d.mts +15 -0
- package/dist/telemetry.mjs +117 -0
- package/dist/{types-BJFeMXWZ.d.mts → types.d.mts} +3 -2
- package/dist/urls.d.mts +7 -0
- package/dist/urls.mjs +21 -0
- package/dist/utils.d.mts +8 -0
- package/dist/utils.mjs +22 -0
- package/package.json +21 -3
- package/dist/agent-DkAidqtV.mjs +0 -9026
- package/dist/api-reference-BYee4zMo.mjs +0 -3046
- package/dist/prompt-references-DMgbu_dz.mjs +0 -1082
- package/dist/retrieval-digest-AOx2-LbC.d.mts +0 -367
- package/dist/sidebar-CFHBj29f.mjs +0 -421
- package/dist/sidebar-CMPbVfGP.d.mts +0 -63
- /package/dist/{openapi-CfCzX_a1.mjs → cli/openapi.mjs} +0 -0
package/dist/index.mjs
CHANGED
|
@@ -1,17 +1,43 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
1
|
+
import { DEFAULT_DOCS_JSON_BODY_MAX_BYTES, readDocsJsonBody } from "./http-body.mjs";
|
|
2
|
+
import { filterDocsPagesByAccess, isDocsAgentPageAccessible, isDocsPageAccessAllowed, normalizeDocsPageAccessPolicy } from "./access.mjs";
|
|
3
|
+
import { defineDocs } from "./define-docs.mjs";
|
|
4
|
+
import { DOCS_AGENT_TRACE_EVENT_TYPES, createDocsAgentTraceContext, createDocsAgentTraceId, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, getDocsRequestAnalyticsProperties, resolveDocsAnalyticsConfig, resolveDocsObservabilityConfig } from "./analytics.mjs";
|
|
5
|
+
import { DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN } from "./agent-detection.mjs";
|
|
6
|
+
import { normalizeDocsUrlPath, toDocsMarkdownUrl } from "./urls.mjs";
|
|
7
|
+
import { DEFAULT_DOCS_OKF_ROUTE, DOCS_OKF_BUNDLE_FORMAT, DOCS_OKF_VERSION, buildDocsOkfBundle, normalizeDocsOkfTrustMetadataInput, resolveDocsOkfConfig, resolveDocsOkfTrustMetadata } from "./okf.mjs";
|
|
8
|
+
import { DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, buildDocsMcpProtectedResourceMetadataRoute, getDocsMcpProtectedResourceMetadataRoutes, getDocsMcpResourcePaths, hasDocsMcpProtectedResourceConfig, isDocsMcpRequest } from "./mcp-auth.mjs";
|
|
9
|
+
import { PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, getPageAgentFrontmatterIssues, hasStructuredPageAgentContract, normalizePageAgentFrontmatter, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, stripGeneratedPageAgentContractMarkdown, upsertPageAgentContractMarkdown } from "./agent-contract.mjs";
|
|
10
|
+
import { normalizeDocsRelated, renderDocsRelatedMarkdownLines } from "./related.mjs";
|
|
11
|
+
import { applyDocsMarkdownHeadingAnchors, cleanDocsRenderedHeadingLabel, createDocsMarkdownHeadingAnchorResolver, createDocsRenderedHeadingAnchorResolver, slugifyDocsMarkdownHeading, withDocsMarkdownRenderableHeadings } from "./markdown-sections.mjs";
|
|
12
|
+
import { digestDocsContent, digestDocsRetrievalContent, isDocsRetrievalCanonicalUrl, sha256DocsContent } from "./retrieval-digest.mjs";
|
|
13
|
+
import { DocsPaginationCursorError } from "./pagination.mjs";
|
|
14
|
+
import { resolveDocsAudienceExposure } from "./audience-exposure.mjs";
|
|
15
|
+
import { findDocsAudienceMdxIssues, resolveDocsAgentMdxContent, resolveDocsAudienceMdxContent } from "./audience.mjs";
|
|
16
|
+
import { DocsSearchRequestError, buildDocsAskAIContext, buildDocsContentSnapshot, buildDocsRetrievalDigestProjection, buildDocsSearchDocuments, buildDocsSearchFacets, createAlgoliaSearchAdapter, createCustomSearchAdapter, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, enrichDocsSearchDocumentsWithProvenance, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, normalizeDocsSearchFilters, performDocsSearch, performDocsSearchWithMetadata, resolveAskAISearchRequestConfig, resolveDocsRetrievalLastModified, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchFilters, resolveDocsSearchRequest, resolveLocalDocsMcpSearchConfig, resolveSearchRequestConfig } from "./search.mjs";
|
|
17
|
+
import { DOCS_CONTENT_CHANGES_FORMAT, DOCS_CONTENT_CHANGES_RESPONSE_VALUE, DOCS_CONTENT_SNAPSHOT_FORMAT, DocsContentChangesRequestError, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, isDocsContentChangeGeneration, isDocsContentChangesRequest, resolveDocsContentChangesConfig, resolveDocsContentChangesRequest } from "./content-changes.mjs";
|
|
18
|
+
import { createDocsCacheableResponse, formatDocsContentDigest, requestHasFreshDocsDate, requestMatchesDocsEtag, resolveDocsHttpDate } from "./http-cache.mjs";
|
|
8
19
|
import { AGENT_SKILL_COMPATIBILITY_MAX_LENGTH, AGENT_SKILL_DESCRIPTION_MAX_LENGTH, AGENT_SKILL_FRONTMATTER_FIELDS, AGENT_SKILL_NAME_MAX_LENGTH, DocsAgentSkillFrontmatterError, isDocsAgentSkillName, parseDocsAgentSkillFrontmatter, validateDocsAgentSkillFrontmatter } from "./agent-skills-spec.mjs";
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
20
|
+
import { AGENT_SKILLS_DISCOVERY_SCHEMA_URI, API_CATALOG_MEDIA_TYPE, API_CATALOG_PROFILE_URI, DEFAULT_A2A_AGENT_CARD_FORMAT, DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_A2A_PROTOCOL_BINDING, DEFAULT_A2A_PROTOCOL_VERSION, DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_INDEX_FORMAT, DEFAULT_AGENT_SKILLS_INDEX_ROUTE, DEFAULT_AGENT_SKILLS_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT, DEFAULT_AGENT_SKILL_FILE_FORMAT, DEFAULT_AGENT_SKILL_FORMAT, DEFAULT_AGENT_SKILL_RESOURCE_FORMAT, DEFAULT_API_CATALOG_FORMAT, DEFAULT_API_CATALOG_ROUTE, DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, DOCS_AGENT_MANIFEST_FORMAT, DOCS_AGENT_MANIFEST_SCHEMA_MEDIA_TYPE, DOCS_AGENT_MANIFEST_SCHEMA_URI, DOCS_AGENT_MANIFEST_VERSION, appendDocsDiscoveryLinkHeader, buildDocsA2AAgentCard, buildDocsAgentSkillsIndex, buildDocsApiCatalog, buildDocsLegacySkillsIndex, createDocsStandardsResponse, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsStandardsDiscoveryRequest, resolveDocsDiscoveryApiRoute, resolveDocsPublishedAgentSkill, resolveDocsStandardsDiscoveryRequest, sha256DocsDiscoveryContent } from "./standards-discovery.mjs";
|
|
21
|
+
import { DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, buildDocsSitemapManifest, createDocsSitemapResponse, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, toDocsSitemapMarkdownUrl } from "./sitemap.mjs";
|
|
22
|
+
import { 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_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_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_OPENAPI_SCHEMA_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_MARKDOWN_SECTION_INDEX_FORMAT, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, acceptsDocsMarkdown, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMarkdownSectionIndex, buildDocsMcpEndpointCandidates, collectDocsMarkdownSections, compactDocsAgentDiscoverySpec, createDocsMarkdownResponse, createDocsStandardsDiscoveryResponse, detectDocsMarkdownAgentRequest, findDocsMarkdownPage, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMarkdownSectionIndexRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, parseDocsAgentFeedbackData, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsSkillDocument, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentsFormat, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMarkdownSectionRequest, resolveDocsOpenApiDiscoveryConfig, resolveDocsRequestApiRoute, resolveDocsSkillFormat, selectDocsLlmsTxtContent, selectDocsMarkdownSection, validateDocsAgentFeedbackPayload, withDocsOpenApiOperationCounts } from "./agent.mjs";
|
|
23
|
+
import { emitDocsTelemetryEvent, emitDocsTelemetryPageViewEvent, isLocalDocsTelemetryOrigin, normalizeDocsTelemetryOrigin, resolveDocsTelemetryConfig } from "./telemetry-runtime.mjs";
|
|
24
|
+
import { emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, getDocsTelemetryFeatures, inferDocsTelemetryAgentSurface } from "./telemetry.mjs";
|
|
25
|
+
import { resolveChangelogConfig } from "./changelog.mjs";
|
|
26
|
+
import { formatDocsLastModifiedDate } from "./date.mjs";
|
|
27
|
+
import { deepMerge } from "./utils.mjs";
|
|
28
|
+
import { createTheme, extendTheme } from "./create-theme.mjs";
|
|
29
|
+
import { resolveDocsI18n, resolveDocsLocale, resolveDocsPath } from "./i18n.mjs";
|
|
30
|
+
import { DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_ROBOTS_TXT_ROUTE, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, analyzeDocsRobotsTxt, createDocsRobotsResponse, getDocsRobotsAllowRoutes, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, resolveDocsRobotsConfig, resolveDocsRobotsRequest, upsertDocsRobotsGeneratedBlock } from "./robots.mjs";
|
|
31
|
+
import { DOCS_AGENT_CONTRACT_VERSION, createDocsAgentContractCases, runDocsAgentConformance } from "./agent-conformance.mjs";
|
|
32
|
+
import { buildDocsPageStructuredData, buildPageOpenGraph, buildPageTwitter, renderDocsPageStructuredDataJson, resolveDocsMetadataBaseUrl, resolveOGImage, resolveTitle } from "./metadata.mjs";
|
|
33
|
+
import { estimateReadingTimeMinutes, resolvePageReadingTime, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions } from "./reading-time.mjs";
|
|
34
|
+
import { DOCS_AGENT_FEEDBACK_EVALUATION_BASELINE_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_CANDIDATES_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_REGRESSION_FORMAT, buildDocsAgentFeedbackEvaluationCandidates, compareDocsAgentFeedbackEvaluationBaseline, createDocsAgentFeedbackEvaluationBaseline } from "./agent-feedback-evaluations.mjs";
|
|
35
|
+
import { DOCS_AGENT_MAINTENANCE_PROPOSAL_FORMAT, analyzeDocsAgentMaintenanceSignals, parseDocsAgentMaintenanceSignals } from "./agent-maintenance.mjs";
|
|
36
|
+
import { applySidebarFolderIndexBehavior, resolvePageSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath } from "./sidebar.mjs";
|
|
37
|
+
import { GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, hashGeneratedAgentContent, normalizeGeneratedAgentContent, parseGeneratedAgentDocument, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance } from "./agent-provenance.mjs";
|
|
38
|
+
import { encodeDocsHeadingTocUrls } from "./heading-toc.mjs";
|
|
39
|
+
import { isolateDocsMarkdownPromptReferences } from "./prompt-references.mjs";
|
|
40
|
+
import { DEFAULT_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, DOCS_CONTENT_CHANGE_HYDRATION_FORMAT, MAX_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, MIN_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, hydrateDocsContentChanges } from "./content-change-hydration.mjs";
|
|
41
|
+
import { resolveDocsOpenApiMcpBaseUrl, resolveDocsOpenApiMcpOperations } from "./openapi-mcp.mjs";
|
|
16
42
|
|
|
17
43
|
export { AGENT_SKILLS_DISCOVERY_SCHEMA_URI, AGENT_SKILL_COMPATIBILITY_MAX_LENGTH, AGENT_SKILL_DESCRIPTION_MAX_LENGTH, AGENT_SKILL_FRONTMATTER_FIELDS, AGENT_SKILL_NAME_MAX_LENGTH, API_CATALOG_MEDIA_TYPE, API_CATALOG_PROFILE_URI, DEFAULT_A2A_AGENT_CARD_FORMAT, DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_A2A_PROTOCOL_BINDING, DEFAULT_A2A_PROTOCOL_VERSION, 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_SKILLS_ARCHIVE_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_INDEX_FORMAT, DEFAULT_AGENT_SKILLS_INDEX_ROUTE, DEFAULT_AGENT_SKILLS_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT, DEFAULT_AGENT_SKILL_FILE_FORMAT, DEFAULT_AGENT_SKILL_FORMAT, DEFAULT_AGENT_SKILL_RESOURCE_FORMAT, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_API_CATALOG_FORMAT, DEFAULT_API_CATALOG_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_DOCS_JSON_BODY_MAX_BYTES, DEFAULT_DOCS_OKF_ROUTE, DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, 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_PROTECTED_RESOURCE_METADATA_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_CONTRACT_VERSION, DOCS_AGENT_FEEDBACK_EVALUATION_BASELINE_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_CANDIDATES_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_REGRESSION_FORMAT, DOCS_AGENT_MAINTENANCE_PROPOSAL_FORMAT, DOCS_AGENT_MANIFEST_FORMAT, DOCS_AGENT_MANIFEST_SCHEMA_MEDIA_TYPE, DOCS_AGENT_MANIFEST_SCHEMA_URI, DOCS_AGENT_MANIFEST_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_CONTENT_CHANGES_FORMAT, DOCS_CONTENT_CHANGES_RESPONSE_VALUE, DOCS_CONTENT_CHANGE_HYDRATION_FORMAT, DOCS_CONTENT_SNAPSHOT_FORMAT, DOCS_MARKDOWN_SECTION_INDEX_FORMAT, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_OKF_BUNDLE_FORMAT, DOCS_OKF_VERSION, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, DocsAgentSkillFrontmatterError, DocsContentChangesRequestError, DocsPaginationCursorError, DocsSearchRequestError, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, MAX_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, MIN_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, acceptsDocsMarkdown, analyzeDocsAgentMaintenanceSignals, analyzeDocsRobotsTxt, appendDocsDiscoveryLinkHeader, applyDocsMarkdownHeadingAnchors, applySidebarFolderIndexBehavior, buildDocsA2AAgentCard, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackEvaluationCandidates, buildDocsAgentFeedbackSchema, buildDocsAgentSkillsIndex, buildDocsApiCatalog, buildDocsAskAIContext, buildDocsConfigMap, buildDocsContentSnapshot, buildDocsDiagnostics, buildDocsLegacySkillsIndex, buildDocsMarkdownSectionIndex, buildDocsMcpEndpointCandidates, buildDocsMcpProtectedResourceMetadataRoute, buildDocsOkfBundle, buildDocsPageStructuredData, buildDocsRetrievalDigestProjection, buildDocsSearchDocuments, buildDocsSearchFacets, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, cleanDocsRenderedHeadingLabel, collectDocsMarkdownSections, compactDocsAgentDiscoverySpec, compareDocsAgentFeedbackEvaluationBaseline, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentFeedbackEvaluationBaseline, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCacheableResponse, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsMarkdownHeadingAnchorResolver, createDocsMarkdownResponse, createDocsRenderedHeadingAnchorResolver, createDocsRobotsResponse, createDocsSitemapResponse, createDocsStandardsDiscoveryResponse, createDocsStandardsResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, digestDocsContent, digestDocsRetrievalContent, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryPageViewEvent, emitDocsTelemetryProjectEvent, encodeDocsHeadingTocUrls, enrichDocsSearchDocumentsWithProvenance, estimateReadingTimeMinutes, extendTheme, filterDocsPagesByAccess, findDocsAudienceMdxIssues, findDocsMarkdownPage, formatDocsAskAIPackageHints, formatDocsContentDigest, formatDocsLastModifiedDate, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsMcpProtectedResourceMetadataRoutes, getDocsMcpResourcePaths, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasDocsMcpProtectedResourceConfig, hasStructuredPageAgentContract, hashGeneratedAgentContent, hydrateDocsContentChanges, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentPageAccessible, isDocsAgentSkillName, isDocsAgentsRequest, isDocsConfigRequest, isDocsContentChangeGeneration, isDocsContentChangesRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMarkdownSectionIndexRequest, isDocsMcpRequest, isDocsPageAccessAllowed, isDocsPublicGetRequest, isDocsRetrievalCanonicalUrl, isDocsSkillRequest, isDocsStandardsDiscoveryRequest, isLocalDocsTelemetryOrigin, isolateDocsMarkdownPromptReferences, matchesDocsLlmsTxtSection, normalizeDocsOkfTrustMetadataInput, normalizeDocsPageAccessPolicy, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsSearchFilters, normalizeDocsTelemetryOrigin, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseDocsAgentMaintenanceSignals, parseDocsAgentSkillFrontmatter, parseGeneratedAgentDocument, performDocsSearch, performDocsSearchWithMetadata, readDocsJsonBody, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, requestHasFreshDocsDate, requestMatchesDocsEtag, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsAudienceExposure, resolveDocsAudienceMdxContent, resolveDocsContentChangesConfig, resolveDocsContentChangesRequest, resolveDocsDiscoveryApiRoute, resolveDocsHttpDate, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMarkdownSectionRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOkfConfig, resolveDocsOkfTrustMetadata, resolveDocsOpenApiDiscoveryConfig, resolveDocsOpenApiMcpBaseUrl, resolveDocsOpenApiMcpOperations, resolveDocsPath, resolveDocsPublishedAgentSkill, resolveDocsRequestApiRoute, resolveDocsRetrievalLastModified, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchFilters, resolveDocsSearchRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsStandardsDiscoveryRequest, resolveDocsTelemetryConfig, resolveLocalDocsMcpSearchConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, selectDocsMarkdownSection, serializeGeneratedAgentDocument, sha256DocsContent, sha256DocsDiscoveryContent, slugifyDocsMarkdownHeading, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload, validateDocsAgentSkillFrontmatter, withDocsMarkdownRenderableHeadings, withDocsOpenApiOperationCounts };
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
//#region src/markdown-section-cache.ts
|
|
2
|
+
/** Retain source spans instead of duplicating nested section text in the cache. */
|
|
3
|
+
function createDocsMarkdownSectionCache({ maxEntries = 1024, maxCharacters = 8e6 } = {}) {
|
|
4
|
+
const entries = /* @__PURE__ */ new Map();
|
|
5
|
+
let characters = 0;
|
|
6
|
+
return {
|
|
7
|
+
get(source) {
|
|
8
|
+
const entry = entries.get(source);
|
|
9
|
+
if (!entry) return void 0;
|
|
10
|
+
entries.delete(source);
|
|
11
|
+
entries.set(source, entry);
|
|
12
|
+
return entry.sections.map(({ start, end, ...section }) => ({
|
|
13
|
+
...section,
|
|
14
|
+
content: entry.source.slice(start, end).trim()
|
|
15
|
+
}));
|
|
16
|
+
},
|
|
17
|
+
set(source, sections) {
|
|
18
|
+
const previous = entries.get(source);
|
|
19
|
+
if (previous) {
|
|
20
|
+
characters -= previous.characters;
|
|
21
|
+
entries.delete(source);
|
|
22
|
+
}
|
|
23
|
+
const normalized = source.replace(/\r\n/g, "\n");
|
|
24
|
+
const size = sections.reduce((total, section) => total + section.title.length + section.anchor.length, source.length + (normalized === source ? 0 : normalized.length));
|
|
25
|
+
if (maxEntries < 1 || size > maxCharacters) return;
|
|
26
|
+
const lineStarts = [0];
|
|
27
|
+
for (let index = normalized.indexOf("\n"); index !== -1; index = normalized.indexOf("\n", index + 1)) lineStarts.push(index + 1);
|
|
28
|
+
entries.set(source, {
|
|
29
|
+
source: normalized,
|
|
30
|
+
sections: sections.map(({ content: _content, ...section }) => ({
|
|
31
|
+
...section,
|
|
32
|
+
start: lineStarts[section.startLine - 1],
|
|
33
|
+
end: lineStarts[section.endLine] ?? normalized.length
|
|
34
|
+
})),
|
|
35
|
+
characters: size
|
|
36
|
+
});
|
|
37
|
+
characters += size;
|
|
38
|
+
while (entries.size > maxEntries || characters > maxCharacters) {
|
|
39
|
+
const oldest = entries.entries().next().value;
|
|
40
|
+
if (!oldest) break;
|
|
41
|
+
characters -= oldest[1].characters;
|
|
42
|
+
entries.delete(oldest[0]);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
//#endregion
|
|
49
|
+
export { createDocsMarkdownSectionCache };
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
//#region src/markdown-sections.d.ts
|
|
2
|
+
interface DocsMarkdownHeadingAnchor {
|
|
3
|
+
/** Heading source without a trailing Fumadocs custom-id marker. */
|
|
4
|
+
source: string;
|
|
5
|
+
/** Visible heading label with common inline Markdown removed. */
|
|
6
|
+
title: string;
|
|
7
|
+
/** Canonical fragment identifier shared by rendered and agent surfaces. */
|
|
8
|
+
anchor: string;
|
|
9
|
+
/** Whether the anchor came from a trailing `[#custom-id]` marker. */
|
|
10
|
+
explicit: boolean;
|
|
11
|
+
}
|
|
12
|
+
interface DocsRenderedHeadingAnchorOptions {
|
|
13
|
+
/** An author-provided or previously assigned fragment identifier. */
|
|
14
|
+
explicitAnchor?: string;
|
|
15
|
+
}
|
|
16
|
+
interface ApplyDocsMarkdownHeadingAnchorsOptions {
|
|
17
|
+
/** Honor trailing Fumadocs `[#custom-id]` markers. */
|
|
18
|
+
customId?: boolean;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Run a third-party heading visitor without exposing headings inside `<Prompt>`.
|
|
22
|
+
*
|
|
23
|
+
* Prompt children are literal, copyable input rather than rendered page content.
|
|
24
|
+
* The node types are restored synchronously even when the visitor throws.
|
|
25
|
+
*/
|
|
26
|
+
declare function withDocsMarkdownRenderableHeadings<T>(root: unknown, visitor: () => T): T;
|
|
27
|
+
/** Normalize text that has already been flattened from a rendered heading AST. */
|
|
28
|
+
declare function cleanDocsRenderedHeadingLabel(value: string): string;
|
|
29
|
+
/**
|
|
30
|
+
* Create a stateful resolver for text already flattened by an MDX renderer.
|
|
31
|
+
*
|
|
32
|
+
* Unlike the raw-Markdown resolver, this does not reinterpret inline code or a
|
|
33
|
+
* literal `[#id]` as Markdown syntax.
|
|
34
|
+
*/
|
|
35
|
+
declare function createDocsRenderedHeadingAnchorResolver(): (value: string, options?: DocsRenderedHeadingAnchorOptions) => DocsMarkdownHeadingAnchor;
|
|
36
|
+
declare function createDocsMarkdownHeadingAnchorResolver(): (value: string) => DocsMarkdownHeadingAnchor;
|
|
37
|
+
/**
|
|
38
|
+
* Assign canonical IDs to every heading in an MDX syntax tree.
|
|
39
|
+
*
|
|
40
|
+
* Render adapters call this before Fumadocs extracts its TOC, ensuring HTML,
|
|
41
|
+
* Markdown retrieval, search, Ask AI, and MCP all use the same fragments.
|
|
42
|
+
*/
|
|
43
|
+
declare function applyDocsMarkdownHeadingAnchors(root: unknown, options?: ApplyDocsMarkdownHeadingAnchorsOptions): void;
|
|
44
|
+
/** Resolve one heading with the canonical GitHub-style anchor algorithm. */
|
|
45
|
+
declare function slugifyDocsMarkdownHeading(value: string): string;
|
|
46
|
+
//#endregion
|
|
47
|
+
export { ApplyDocsMarkdownHeadingAnchorsOptions, DocsMarkdownHeadingAnchor, DocsRenderedHeadingAnchorOptions, applyDocsMarkdownHeadingAnchors, cleanDocsRenderedHeadingLabel, createDocsMarkdownHeadingAnchorResolver, createDocsRenderedHeadingAnchorResolver, slugifyDocsMarkdownHeading, withDocsMarkdownRenderableHeadings };
|