@farming-labs/docs 0.2.91 → 0.2.93
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-Vk9oUKpQ.d.mts → agent-DGEdQ0Nh.d.mts} +2 -2
- package/dist/{agent-evals-GFDpcXO3.mjs → agent-evals-CKZ7bPSp.mjs} +44 -2
- package/dist/{agent-export-CNDoSwv4.mjs → agent-export-BuLVkNkL.mjs} +3 -3
- package/dist/agent-skills-bundle.d.mts +1 -1
- package/dist/{agent-skills-server-Cltp5qai.d.mts → agent-skills-server-14HFIrBY.d.mts} +2 -2
- package/dist/agent-skills-vite.d.mts +3 -3
- package/dist/{agents-CUPf3vZe.mjs → agents-CNtukMtM.mjs} +3 -3
- package/dist/cli/index.mjs +30 -30
- package/dist/client/react.d.mts +1 -1
- package/dist/{cloud-DwhH_b_q.mjs → cloud-CojpBKC-.mjs} +1 -1
- package/dist/{cloud-ask-ai-Da6md6U7.d.mts → cloud-ask-ai-B2v4Nry-.d.mts} +1 -1
- package/dist/{dev-BFBPvjnk.mjs → dev-DugcMDQQ.mjs} +2 -2
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/{doctor-DTUnmCWU.mjs → doctor-_Ceveoj7.mjs} +19 -11
- package/dist/{downgrade-Wcgqbfv_.mjs → downgrade-Dn_p7yMn.mjs} +3 -3
- package/dist/{golden-evaluations-CjpJSUEg.mjs → golden-evaluations-AH4y5QDu.mjs} +1 -0
- package/dist/index.d.mts +5 -5
- package/dist/{init-CuLodGjP.mjs → init-ClizlMoO.mjs} +61 -9
- package/dist/{mcp-DYVbyw5b.mjs → mcp-Dxg2FzSt.mjs} +2 -2
- package/dist/mcp.d.mts +3 -3
- package/dist/{package-version-B3PJ6IDr.mjs → package-version-ZAEdrNDw.mjs} +8 -2
- package/dist/{retrieval-digest-Dl7Bx121.d.mts → retrieval-digest-DMqcN_MK.d.mts} +2 -2
- package/dist/{review-BjOfzbsm.mjs → review-BfQvzPWj.mjs} +3 -3
- package/dist/{robots-B4zuleV8.mjs → robots-C8M6odcB.mjs} +1 -1
- package/dist/{search-DRSqR1_k.mjs → search-CA_eLPUX.mjs} +2 -2
- package/dist/server.d.mts +38 -12
- package/dist/server.mjs +2 -2
- package/dist/{sitemap-BiaR2pC_.mjs → sitemap-C8xaervA.mjs} +3 -3
- package/dist/{sitemap-server-rv00bP21.mjs → sitemap-server-JffNpEef.mjs} +11 -0
- package/dist/{skills-Biq9Q7z4.mjs → skills-BgqqsITg.mjs} +2 -2
- package/dist/{standards-discovery-DX9iiGar.d.mts → standards-discovery-B7L9pSnQ.d.mts} +1 -1
- package/dist/{templates-Co7I_Okv.mjs → templates-BTIO0i_g.mjs} +104 -3
- package/dist/{types-DUMzbRER.d.mts → types-CMNYudRn.d.mts} +1 -1
- package/dist/{upgrade-BSCjUH0V.mjs → upgrade-CTW2Xlxm.mjs} +3 -3
- package/dist/{utils-DpiIioYb.mjs → utils-C4U_e1aw.mjs} +1 -0
- package/package.json +1 -1
|
@@ -699,6 +699,107 @@ pnpm build
|
|
|
699
699
|
Deploy to Vercel, Netlify, or any Node.js hosting platform.
|
|
700
700
|
`;
|
|
701
701
|
}
|
|
702
|
+
function farmjsDocsConfigTemplate(cfg) {
|
|
703
|
+
return tanstackDocsConfigTemplate(cfg);
|
|
704
|
+
}
|
|
705
|
+
function farmjsConfigTemplate() {
|
|
706
|
+
return `\
|
|
707
|
+
import { defineConfig } from "@farm.js/core";
|
|
708
|
+
import { withDocs } from "@farming-labs/farmjs/config";
|
|
709
|
+
|
|
710
|
+
export default withDocs(defineConfig({}));
|
|
711
|
+
`;
|
|
712
|
+
}
|
|
713
|
+
function injectFarmjsConfig(content) {
|
|
714
|
+
if (!content || content.includes("@farming-labs/farmjs/config")) return null;
|
|
715
|
+
if (/export\s+default\s+(?:async\s+)?(?:function|class)\b/.test(content)) return null;
|
|
716
|
+
const exportMatch = content.match(/export\s+default\s+/);
|
|
717
|
+
if (!exportMatch || exportMatch.index === void 0) return null;
|
|
718
|
+
const withImport = addImportLine(content, "import { withDocs } from \"@farming-labs/farmjs/config\";");
|
|
719
|
+
const defaultExport = withImport.match(/export\s+default\s+/);
|
|
720
|
+
if (!defaultExport || defaultExport.index === void 0) return null;
|
|
721
|
+
const start = defaultExport.index;
|
|
722
|
+
const end = start + defaultExport[0].length;
|
|
723
|
+
return `${`${withImport.slice(0, start)}const farmConfig = ${withImport.slice(end)}`.trimEnd()}\n\nexport default withDocs(farmConfig);\n`;
|
|
724
|
+
}
|
|
725
|
+
function farmjsWelcomePageTemplate(cfg) {
|
|
726
|
+
return `\
|
|
727
|
+
---
|
|
728
|
+
title: "Documentation"
|
|
729
|
+
description: "Welcome to ${cfg.projectName} documentation"
|
|
730
|
+
---
|
|
731
|
+
|
|
732
|
+
# Welcome to ${cfg.projectName}
|
|
733
|
+
|
|
734
|
+
This documentation is powered by \`@farming-labs/docs\` and Farm.js.
|
|
735
|
+
|
|
736
|
+
## Overview
|
|
737
|
+
|
|
738
|
+
- Content lives in \`${cfg.entry}/\`
|
|
739
|
+
- Farm serves it at \`/${cfg.entry}\`
|
|
740
|
+
- Search and agent endpoints are wired automatically
|
|
741
|
+
|
|
742
|
+
## Next Steps
|
|
743
|
+
|
|
744
|
+
Read the [Installation](/${cfg.entry}/installation) guide, then continue to [Quickstart](/${cfg.entry}/quickstart).
|
|
745
|
+
`;
|
|
746
|
+
}
|
|
747
|
+
function farmjsInstallationPageTemplate(cfg) {
|
|
748
|
+
return `\
|
|
749
|
+
---
|
|
750
|
+
title: "Installation"
|
|
751
|
+
description: "Add Farming Labs docs to ${cfg.projectName}"
|
|
752
|
+
---
|
|
753
|
+
|
|
754
|
+
# Installation
|
|
755
|
+
|
|
756
|
+
Install the docs runtime and Farm adapter:
|
|
757
|
+
|
|
758
|
+
\`\`\`bash
|
|
759
|
+
pnpm add @farming-labs/docs @farming-labs/farmjs @farming-labs/theme
|
|
760
|
+
\`\`\`
|
|
761
|
+
|
|
762
|
+
Wrap the existing Farm config:
|
|
763
|
+
|
|
764
|
+
\`\`\`ts title="farm.config.ts"
|
|
765
|
+
import { defineConfig } from "@farm.js/core";
|
|
766
|
+
import { withDocs } from "@farming-labs/farmjs/config";
|
|
767
|
+
|
|
768
|
+
export default withDocs(
|
|
769
|
+
defineConfig({
|
|
770
|
+
preset: "vercel",
|
|
771
|
+
}),
|
|
772
|
+
);
|
|
773
|
+
\`\`\`
|
|
774
|
+
|
|
775
|
+
Documentation settings stay in \`docs.config.ts\`, while content lives in \`${cfg.entry}/\`.
|
|
776
|
+
`;
|
|
777
|
+
}
|
|
778
|
+
function farmjsQuickstartPageTemplate(cfg) {
|
|
779
|
+
return `\
|
|
780
|
+
---
|
|
781
|
+
title: "Quickstart"
|
|
782
|
+
description: "Publish your first ${cfg.projectName} documentation page"
|
|
783
|
+
---
|
|
784
|
+
|
|
785
|
+
# Quickstart
|
|
786
|
+
|
|
787
|
+
Create a page under \`${cfg.entry}/guides/page.md\`:
|
|
788
|
+
|
|
789
|
+
\`\`\`md title="${cfg.entry}/guides/page.md"
|
|
790
|
+
---
|
|
791
|
+
title: "Guides"
|
|
792
|
+
description: "Product guides"
|
|
793
|
+
---
|
|
794
|
+
|
|
795
|
+
# Guides
|
|
796
|
+
|
|
797
|
+
Write your documentation here.
|
|
798
|
+
\`\`\`
|
|
799
|
+
|
|
800
|
+
Run the Farm development server and open [/${cfg.entry}](/${cfg.entry}). New pages are discovered from the content tree.
|
|
801
|
+
`;
|
|
802
|
+
}
|
|
702
803
|
function tanstackDocsConfigTemplate(cfg) {
|
|
703
804
|
if (cfg.theme === "custom" && cfg.customThemeName) {
|
|
704
805
|
const exportName = getThemeExportName(cfg.customThemeName);
|
|
@@ -709,7 +810,7 @@ import { ${exportName} } from "./themes/${cfg.customThemeName.replace(/\.ts$/i,
|
|
|
709
810
|
export default defineDocs({
|
|
710
811
|
entry: "${cfg.entry}",
|
|
711
812
|
contentDir: "${cfg.entry}",
|
|
712
|
-
${renderApiReferenceConfig(cfg)} theme: ${exportName}({
|
|
813
|
+
${renderI18nConfig(cfg)}${renderApiReferenceConfig(cfg)} theme: ${exportName}({
|
|
713
814
|
ui: {
|
|
714
815
|
colors: { primary: "#6366f1" },
|
|
715
816
|
},
|
|
@@ -737,7 +838,7 @@ import { ${t.factory} } from "${t.nextImport}";
|
|
|
737
838
|
export default defineDocs({
|
|
738
839
|
entry: "${cfg.entry}",
|
|
739
840
|
contentDir: "${cfg.entry}",
|
|
740
|
-
${renderApiReferenceConfig(cfg)} theme: ${t.factory}({
|
|
841
|
+
${renderI18nConfig(cfg)}${renderApiReferenceConfig(cfg)} theme: ${t.factory}({
|
|
741
842
|
ui: {
|
|
742
843
|
colors: { primary: "#6366f1" },
|
|
743
844
|
},
|
|
@@ -2536,4 +2637,4 @@ function injectNuxtCssImport(existingContent, theme, customThemeName, globalCssR
|
|
|
2536
2637
|
}
|
|
2537
2638
|
|
|
2538
2639
|
//#endregion
|
|
2539
|
-
export {
|
|
2640
|
+
export { postcssConfigTemplate as $, injectNuxtAgentSkillsPlugin as A, welcomePageTemplate as At, nextConfigTemplate as B, globalCssTemplate as C, tanstackDocsServerTemplate as Ct, injectCssImport as D, tanstackViteConfigTemplate as Dt, injectAstroDocsMiddleware as E, tanstackRootRouteTemplate as Et, injectTanstackRootProviderIntoRoute as F, nuxtDocsPageTemplate as G, nextLocalizedPageTemplate as H, injectTanstackVitePlugins as I, nuxtQuickstartPageTemplate as J, nuxtGlobalCssTemplate as K, installationPageTemplate as L, injectRootProviderIntoLayout as M, injectSvelteCssImport as N, injectDocsAgentSkillsVitePlugin as O, tanstackWelcomePageTemplate as Ot, injectSvelteDocsPublicHook as P, nuxtWelcomePageTemplate as Q, nextApiReferencePageTemplate as R, getAstroAdapterPkg as S, tanstackDocsPublicRouteTemplate as St, injectAstroCssImport as T, tanstackQuickstartPageTemplate as Tt, nuxtConfigTemplate as U, nextLocaleDocPageTemplate as V, nuxtDocsConfigTemplate as W, nuxtServerApiReferenceRouteTemplate as X, nuxtServerApiDocsRouteTemplate as Y, nuxtServerDocsPublicMiddlewareTemplate as Z, farmjsConfigTemplate as _, tanstackApiReferenceRouteTemplate as _t, astroDocsIndexTemplate as a, svelteDocsLayoutServerTemplate as at, farmjsQuickstartPageTemplate as b, tanstackDocsFunctionsTemplate as bt, astroDocsServerTemplate as c, svelteDocsPublicHookTemplate as ct, astroQuickstartPageTemplate as d, svelteInstallationPageTemplate as dt, quickstartPageTemplate as et, astroWelcomePageTemplate as f, svelteQuickstartPageTemplate as ft, docsLayoutTemplate as g, tanstackApiDocsRouteTemplate as gt, docsConfigTemplate as h, svelteWelcomePageTemplate as ht, astroDocsConfigTemplate as i, svelteDocsConfigTemplate as it, injectNuxtCssImport as j, injectFarmjsConfig as k, tsconfigTemplate as kt, astroGlobalCssTemplate as l, svelteDocsServerTemplate as lt, customThemeTsTemplate as m, svelteViteConfigTemplate as mt, astroApiRouteTemplate as n, svelteApiReferenceRouteTemplate as nt, astroDocsMiddlewareTemplate as o, svelteDocsLayoutTemplate as ot, customThemeCssTemplate as p, svelteRootLayoutTemplate as pt, nuxtInstallationPageTemplate as q, astroConfigTemplate as r, svelteDocsApiRouteTemplate as rt, astroDocsPageTemplate as s, svelteDocsPageTemplate as st, astroApiReferenceRouteTemplate as t, rootLayoutTemplate as tt, astroInstallationPageTemplate as u, svelteGlobalCssTemplate as ut, farmjsDocsConfigTemplate as v, tanstackDocsCatchAllRouteTemplate as vt, injectAstroAgentSkillsPlugin as w, tanstackInstallationPageTemplate as wt, farmjsWelcomePageTemplate as x, tanstackDocsIndexRouteTemplate as xt, farmjsInstallationPageTemplate as y, tanstackDocsConfigTemplate as yt, nextConfigMergedTemplate as z };
|
|
@@ -823,7 +823,7 @@ interface DocsAnalyticsConfig {
|
|
|
823
823
|
*/
|
|
824
824
|
cloud?: boolean;
|
|
825
825
|
}
|
|
826
|
-
type DocsTelemetryFramework = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt" | "mcp" | (string & {});
|
|
826
|
+
type DocsTelemetryFramework = "next" | "tanstack-start" | "farmjs" | "sveltekit" | "astro" | "nuxt" | "mcp" | (string & {});
|
|
827
827
|
type DocsTelemetryEventType = "project_detected" | "agent_surface_used" | "mcp_request" | "mcp_tool_used" | (string & {});
|
|
828
828
|
type DocsTelemetryAgentSurface = "agent_spec" | "agents" | "skill" | "markdown" | "llms" | "agent_feedback_schema" | "agent_feedback_submit" | "content_changes" | "ask_ai" | "mcp";
|
|
829
829
|
interface DocsTelemetryConfig {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { c as fileExists, o as exec } from "./utils-
|
|
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-
|
|
1
|
+
import { c as fileExists, o as exec } from "./utils-C4U_e1aw.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-ZAEdrNDw.mjs";
|
|
3
3
|
import path from "node:path";
|
|
4
4
|
import pc from "picocolors";
|
|
5
5
|
import * as p from "@clack/prompts";
|
|
@@ -7,7 +7,7 @@ import * as p from "@clack/prompts";
|
|
|
7
7
|
//#region src/cli/upgrade.ts
|
|
8
8
|
/**
|
|
9
9
|
* Upgrade @farming-labs/* packages to a dist-tag or exact version.
|
|
10
|
-
* Detects framework from package.json by default, or use --framework (next, tanstack-start, nuxt, sveltekit, astro).
|
|
10
|
+
* Detects framework from package.json by default, or use --framework (next, tanstack-start, farmjs, nuxt, sveltekit, astro).
|
|
11
11
|
*/
|
|
12
12
|
function resolveUpgradeTarget(options) {
|
|
13
13
|
if (options.version !== void 0) return validateUpgradeVersion(options.version);
|
|
@@ -13,6 +13,7 @@ function detectFramework(cwd) {
|
|
|
13
13
|
};
|
|
14
14
|
if (allDeps["next"]) return "nextjs";
|
|
15
15
|
if (allDeps["@tanstack/react-start"]) return "tanstack-start";
|
|
16
|
+
if (allDeps["@farm.js/core"] || allDeps["@farmjs/core"]) return "farmjs";
|
|
16
17
|
if (allDeps["@sveltejs/kit"]) return "sveltekit";
|
|
17
18
|
if (allDeps["astro"]) return "astro";
|
|
18
19
|
if (allDeps["nuxt"]) return "nuxt";
|