@farm.js/create-app 0.1.0-beta.62 → 0.1.0-beta.63
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/package.json +1 -1
- package/templates/_renderers/preact/package.json +2 -2
- package/templates/_renderers/solid/package.json +2 -2
- package/templates/_renderers/svelte/package.json +2 -2
- package/templates/_renderers/vue/package.json +2 -2
- package/templates/auth/docs.config.ts +33 -0
- package/templates/auth/docs.json +36 -0
- package/templates/auth/farm.config.ts +6 -0
- package/templates/auth/package.json +6 -3
- package/templates/auth/src/app/docs/page.md +29 -0
- package/templates/basic/docs.config.ts +33 -0
- package/templates/basic/docs.json +36 -0
- package/templates/basic/farm.config.ts +6 -0
- package/templates/basic/package.json +5 -2
- package/templates/basic/src/app/docs/page.md +29 -0
- package/templates/better-auth/docs.config.ts +33 -0
- package/templates/better-auth/docs.json +36 -0
- package/templates/better-auth/farm.config.ts +6 -0
- package/templates/better-auth/package.json +6 -3
- package/templates/better-auth/src/app/docs/page.md +29 -0
- package/templates/react-compiler/docs.config.ts +33 -0
- package/templates/react-compiler/docs.json +36 -0
- package/templates/react-compiler/farm.config.ts +6 -0
- package/templates/react-compiler/package.json +5 -2
- package/templates/react-compiler/src/app/docs/page.md +29 -0
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"type-check": "tsc --noEmit"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@farm.js/core": "0.1.0-beta.
|
|
13
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
14
14
|
"@farm.js/preact": "0.1.0-beta.31",
|
|
15
15
|
"@fontsource-variable/geist": "5.3.0",
|
|
16
16
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"zod": "4.1.12"
|
|
19
19
|
},
|
|
20
20
|
"devDependencies": {
|
|
21
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
21
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
22
22
|
"tailwindcss": "^4.0.0",
|
|
23
23
|
"typescript": "^5.3.3"
|
|
24
24
|
},
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"type-check": "tsc --noEmit"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@farm.js/core": "0.1.0-beta.
|
|
12
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
13
13
|
"@farm.js/solid": "0.1.0-beta.27",
|
|
14
14
|
"@fontsource-variable/geist": "5.3.0",
|
|
15
15
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"zod": "4.1.12"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
20
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
21
21
|
"tailwindcss": "^4.0.0",
|
|
22
22
|
"typescript": "^5.3.3"
|
|
23
23
|
},
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"type-check": "svelte-check --tsconfig ./tsconfig.json"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@farm.js/core": "0.1.0-beta.
|
|
14
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
15
15
|
"@farm.js/svelte": "0.1.0-beta.30",
|
|
16
16
|
"@fontsource-variable/geist": "5.3.0",
|
|
17
17
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"zod": "4.1.12"
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
22
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
23
23
|
"svelte-check": "4.7.5",
|
|
24
24
|
"tailwindcss": "^4.0.0",
|
|
25
25
|
"typescript": "^5.3.3"
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"type-check": "vue-tsc --noEmit"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@farm.js/core": "0.1.0-beta.
|
|
12
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
13
13
|
"@farm.js/vue": "0.1.0-beta.27",
|
|
14
14
|
"@fontsource-variable/geist": "5.3.0",
|
|
15
15
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"zod": "4.1.12"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
20
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
21
21
|
"tailwindcss": "^4.0.0",
|
|
22
22
|
"typescript": "^5.3.3",
|
|
23
23
|
"vue-tsc": "3.3.9"
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { defineDocs } from "@farming-labs/docs";
|
|
2
|
+
|
|
3
|
+
// Site-wide docs configuration, powered by the @farming-labs/farmjs framework.
|
|
4
|
+
// Farm auto-detects the installed adapter (because farm.config.ts sets
|
|
5
|
+
// `docs: { enabled: true }`), loads this file, and serves Markdown from
|
|
6
|
+
// src/app/docs.
|
|
7
|
+
//
|
|
8
|
+
// This typed config takes priority over docs.json. Keep docs.json in sync as
|
|
9
|
+
// the language-agnostic manifest: it is the fallback for frameworkless / non
|
|
10
|
+
// JS-TS setups and the source the docs cloud reads.
|
|
11
|
+
export default defineDocs({
|
|
12
|
+
entry: "docs",
|
|
13
|
+
docsPath: "/docs",
|
|
14
|
+
metadata: {
|
|
15
|
+
description: "Documentation for your Farm.js app.",
|
|
16
|
+
},
|
|
17
|
+
nav: {
|
|
18
|
+
title: "Farm App",
|
|
19
|
+
url: "/",
|
|
20
|
+
},
|
|
21
|
+
search: {
|
|
22
|
+
provider: "simple",
|
|
23
|
+
enabled: true,
|
|
24
|
+
maxResults: 12,
|
|
25
|
+
},
|
|
26
|
+
llmsTxt: {
|
|
27
|
+
enabled: true,
|
|
28
|
+
siteTitle: "Farm App Docs",
|
|
29
|
+
siteDescription: "Documentation for your Farm.js app.",
|
|
30
|
+
},
|
|
31
|
+
sitemap: true,
|
|
32
|
+
robots: true,
|
|
33
|
+
});
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://docs.farming-labs.dev/schema/docs.json",
|
|
3
|
+
"version": 1,
|
|
4
|
+
"entry": "docs",
|
|
5
|
+
"docsPath": "/docs",
|
|
6
|
+
"docs": {
|
|
7
|
+
"mode": "framework",
|
|
8
|
+
"runtime": "farm",
|
|
9
|
+
"root": "."
|
|
10
|
+
},
|
|
11
|
+
"content": {
|
|
12
|
+
"docsRoot": "src/app/docs"
|
|
13
|
+
},
|
|
14
|
+
"site": {
|
|
15
|
+
"name": "Farm App Docs"
|
|
16
|
+
},
|
|
17
|
+
"metadata": {
|
|
18
|
+
"description": "Documentation for your Farm.js app."
|
|
19
|
+
},
|
|
20
|
+
"nav": {
|
|
21
|
+
"title": "Farm App",
|
|
22
|
+
"url": "/"
|
|
23
|
+
},
|
|
24
|
+
"search": {
|
|
25
|
+
"provider": "simple",
|
|
26
|
+
"enabled": true,
|
|
27
|
+
"maxResults": 12
|
|
28
|
+
},
|
|
29
|
+
"llmsTxt": {
|
|
30
|
+
"enabled": true,
|
|
31
|
+
"siteTitle": "Farm App Docs",
|
|
32
|
+
"siteDescription": "Documentation for your Farm.js app."
|
|
33
|
+
},
|
|
34
|
+
"sitemap": true,
|
|
35
|
+
"robots": true
|
|
36
|
+
}
|
|
@@ -5,6 +5,12 @@ export default defineConfig({
|
|
|
5
5
|
theme: {
|
|
6
6
|
default: "dark",
|
|
7
7
|
},
|
|
8
|
+
// Docs are powered by the @farming-labs/farmjs framework. Farm auto-detects
|
|
9
|
+
// the installed adapter and reads docs.config.ts (docs.json is kept as a
|
|
10
|
+
// language-agnostic fallback/manifest); content lives in src/app/docs.
|
|
11
|
+
docs: {
|
|
12
|
+
enabled: true,
|
|
13
|
+
},
|
|
8
14
|
experimental: {
|
|
9
15
|
serverComponents: true,
|
|
10
16
|
},
|
|
@@ -11,8 +11,11 @@
|
|
|
11
11
|
"type-check": "tsc --noEmit"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@farm.js/auth": "0.1.0-beta.
|
|
15
|
-
"@farm.js/core": "0.1.0-beta.
|
|
14
|
+
"@farm.js/auth": "0.1.0-beta.63",
|
|
15
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
16
|
+
"@farming-labs/docs": "0.2.111",
|
|
17
|
+
"@farming-labs/farmjs": "0.2.111",
|
|
18
|
+
"@farming-labs/theme": "0.2.111",
|
|
16
19
|
"@fontsource-variable/geist": "5.3.0",
|
|
17
20
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
18
21
|
"better-call": "1.3.2",
|
|
@@ -20,7 +23,7 @@
|
|
|
20
23
|
"react-dom": "^19.0.0"
|
|
21
24
|
},
|
|
22
25
|
"devDependencies": {
|
|
23
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
26
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
24
27
|
"@types/node": "20.19.9",
|
|
25
28
|
"@types/react": "^19.0.0",
|
|
26
29
|
"@types/react-dom": "^19.0.0",
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Getting Started"
|
|
3
|
+
description: "Your Farm.js documentation, powered by the @farming-labs/farmjs docs framework."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Getting Started
|
|
7
|
+
|
|
8
|
+
These docs are served by the Farm docs runtime, powered by the
|
|
9
|
+
[@farming-labs/farmjs](https://www.npmjs.com/package/@farming-labs/farmjs) docs
|
|
10
|
+
framework. The same Markdown files power human pages, Markdown routes,
|
|
11
|
+
`llms.txt`, the sitemap, search, and agent discovery through `/api/docs`.
|
|
12
|
+
|
|
13
|
+
## Edit this page
|
|
14
|
+
|
|
15
|
+
This page lives at `src/app/docs/page.md`. Add more pages as folders with their
|
|
16
|
+
own `page.md` — for example `src/app/docs/configuration/page.md` is served at
|
|
17
|
+
`/docs/configuration`.
|
|
18
|
+
|
|
19
|
+
## Configure
|
|
20
|
+
|
|
21
|
+
Site-wide docs settings live in `docs.config.ts` at the project root (title,
|
|
22
|
+
navigation, search, `llms.txt`, sitemap, and robots). Farm auto-detects the
|
|
23
|
+
installed adapter because `farm.config.ts` sets `docs: { enabled: true }` — no
|
|
24
|
+
manual wiring required.
|
|
25
|
+
|
|
26
|
+
## Learn more
|
|
27
|
+
|
|
28
|
+
- [Farm.js documentation](https://farm.js.dev/docs)
|
|
29
|
+
- [Configuration guide](https://farm.js.dev/docs/configuration)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { defineDocs } from "@farming-labs/docs";
|
|
2
|
+
|
|
3
|
+
// Site-wide docs configuration, powered by the @farming-labs/farmjs framework.
|
|
4
|
+
// Farm auto-detects the installed adapter (because farm.config.ts sets
|
|
5
|
+
// `docs: { enabled: true }`), loads this file, and serves Markdown from
|
|
6
|
+
// src/app/docs.
|
|
7
|
+
//
|
|
8
|
+
// This typed config takes priority over docs.json. Keep docs.json in sync as
|
|
9
|
+
// the language-agnostic manifest: it is the fallback for frameworkless / non
|
|
10
|
+
// JS-TS setups and the source the docs cloud reads.
|
|
11
|
+
export default defineDocs({
|
|
12
|
+
entry: "docs",
|
|
13
|
+
docsPath: "/docs",
|
|
14
|
+
metadata: {
|
|
15
|
+
description: "Documentation for your Farm.js app.",
|
|
16
|
+
},
|
|
17
|
+
nav: {
|
|
18
|
+
title: "Farm App",
|
|
19
|
+
url: "/",
|
|
20
|
+
},
|
|
21
|
+
search: {
|
|
22
|
+
provider: "simple",
|
|
23
|
+
enabled: true,
|
|
24
|
+
maxResults: 12,
|
|
25
|
+
},
|
|
26
|
+
llmsTxt: {
|
|
27
|
+
enabled: true,
|
|
28
|
+
siteTitle: "Farm App Docs",
|
|
29
|
+
siteDescription: "Documentation for your Farm.js app.",
|
|
30
|
+
},
|
|
31
|
+
sitemap: true,
|
|
32
|
+
robots: true,
|
|
33
|
+
});
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://docs.farming-labs.dev/schema/docs.json",
|
|
3
|
+
"version": 1,
|
|
4
|
+
"entry": "docs",
|
|
5
|
+
"docsPath": "/docs",
|
|
6
|
+
"docs": {
|
|
7
|
+
"mode": "framework",
|
|
8
|
+
"runtime": "farm",
|
|
9
|
+
"root": "."
|
|
10
|
+
},
|
|
11
|
+
"content": {
|
|
12
|
+
"docsRoot": "src/app/docs"
|
|
13
|
+
},
|
|
14
|
+
"site": {
|
|
15
|
+
"name": "Farm App Docs"
|
|
16
|
+
},
|
|
17
|
+
"metadata": {
|
|
18
|
+
"description": "Documentation for your Farm.js app."
|
|
19
|
+
},
|
|
20
|
+
"nav": {
|
|
21
|
+
"title": "Farm App",
|
|
22
|
+
"url": "/"
|
|
23
|
+
},
|
|
24
|
+
"search": {
|
|
25
|
+
"provider": "simple",
|
|
26
|
+
"enabled": true,
|
|
27
|
+
"maxResults": 12
|
|
28
|
+
},
|
|
29
|
+
"llmsTxt": {
|
|
30
|
+
"enabled": true,
|
|
31
|
+
"siteTitle": "Farm App Docs",
|
|
32
|
+
"siteDescription": "Documentation for your Farm.js app."
|
|
33
|
+
},
|
|
34
|
+
"sitemap": true,
|
|
35
|
+
"robots": true
|
|
36
|
+
}
|
|
@@ -4,6 +4,12 @@ export default defineConfig({
|
|
|
4
4
|
theme: {
|
|
5
5
|
default: "dark",
|
|
6
6
|
},
|
|
7
|
+
// Docs are powered by the @farming-labs/farmjs framework. Farm auto-detects
|
|
8
|
+
// the installed adapter and reads docs.config.ts (docs.json is kept as a
|
|
9
|
+
// language-agnostic fallback/manifest); content lives in src/app/docs.
|
|
10
|
+
docs: {
|
|
11
|
+
enabled: true,
|
|
12
|
+
},
|
|
7
13
|
deploy: {
|
|
8
14
|
target: "vercel",
|
|
9
15
|
},
|
|
@@ -9,14 +9,17 @@
|
|
|
9
9
|
"type-check": "tsc --noEmit"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@farm.js/core": "0.1.0-beta.
|
|
12
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
13
|
+
"@farming-labs/docs": "0.2.111",
|
|
14
|
+
"@farming-labs/farmjs": "0.2.111",
|
|
15
|
+
"@farming-labs/theme": "0.2.111",
|
|
13
16
|
"@fontsource-variable/geist": "5.3.0",
|
|
14
17
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
15
18
|
"react": "^19.0.0",
|
|
16
19
|
"react-dom": "^19.0.0"
|
|
17
20
|
},
|
|
18
21
|
"devDependencies": {
|
|
19
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
22
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
20
23
|
"@types/react": "^19.0.0",
|
|
21
24
|
"@types/react-dom": "^19.0.0",
|
|
22
25
|
"tailwindcss": "^4.0.0",
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Getting Started"
|
|
3
|
+
description: "Your Farm.js documentation, powered by the @farming-labs/farmjs docs framework."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Getting Started
|
|
7
|
+
|
|
8
|
+
These docs are served by the Farm docs runtime, powered by the
|
|
9
|
+
[@farming-labs/farmjs](https://www.npmjs.com/package/@farming-labs/farmjs) docs
|
|
10
|
+
framework. The same Markdown files power human pages, Markdown routes,
|
|
11
|
+
`llms.txt`, the sitemap, search, and agent discovery through `/api/docs`.
|
|
12
|
+
|
|
13
|
+
## Edit this page
|
|
14
|
+
|
|
15
|
+
This page lives at `src/app/docs/page.md`. Add more pages as folders with their
|
|
16
|
+
own `page.md` — for example `src/app/docs/configuration/page.md` is served at
|
|
17
|
+
`/docs/configuration`.
|
|
18
|
+
|
|
19
|
+
## Configure
|
|
20
|
+
|
|
21
|
+
Site-wide docs settings live in `docs.config.ts` at the project root (title,
|
|
22
|
+
navigation, search, `llms.txt`, sitemap, and robots). Farm auto-detects the
|
|
23
|
+
installed adapter because `farm.config.ts` sets `docs: { enabled: true }` — no
|
|
24
|
+
manual wiring required.
|
|
25
|
+
|
|
26
|
+
## Learn more
|
|
27
|
+
|
|
28
|
+
- [Farm.js documentation](https://farm.js.dev/docs)
|
|
29
|
+
- [Configuration guide](https://farm.js.dev/docs/configuration)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { defineDocs } from "@farming-labs/docs";
|
|
2
|
+
|
|
3
|
+
// Site-wide docs configuration, powered by the @farming-labs/farmjs framework.
|
|
4
|
+
// Farm auto-detects the installed adapter (because farm.config.ts sets
|
|
5
|
+
// `docs: { enabled: true }`), loads this file, and serves Markdown from
|
|
6
|
+
// src/app/docs.
|
|
7
|
+
//
|
|
8
|
+
// This typed config takes priority over docs.json. Keep docs.json in sync as
|
|
9
|
+
// the language-agnostic manifest: it is the fallback for frameworkless / non
|
|
10
|
+
// JS-TS setups and the source the docs cloud reads.
|
|
11
|
+
export default defineDocs({
|
|
12
|
+
entry: "docs",
|
|
13
|
+
docsPath: "/docs",
|
|
14
|
+
metadata: {
|
|
15
|
+
description: "Documentation for your Farm.js app.",
|
|
16
|
+
},
|
|
17
|
+
nav: {
|
|
18
|
+
title: "Farm App",
|
|
19
|
+
url: "/",
|
|
20
|
+
},
|
|
21
|
+
search: {
|
|
22
|
+
provider: "simple",
|
|
23
|
+
enabled: true,
|
|
24
|
+
maxResults: 12,
|
|
25
|
+
},
|
|
26
|
+
llmsTxt: {
|
|
27
|
+
enabled: true,
|
|
28
|
+
siteTitle: "Farm App Docs",
|
|
29
|
+
siteDescription: "Documentation for your Farm.js app.",
|
|
30
|
+
},
|
|
31
|
+
sitemap: true,
|
|
32
|
+
robots: true,
|
|
33
|
+
});
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://docs.farming-labs.dev/schema/docs.json",
|
|
3
|
+
"version": 1,
|
|
4
|
+
"entry": "docs",
|
|
5
|
+
"docsPath": "/docs",
|
|
6
|
+
"docs": {
|
|
7
|
+
"mode": "framework",
|
|
8
|
+
"runtime": "farm",
|
|
9
|
+
"root": "."
|
|
10
|
+
},
|
|
11
|
+
"content": {
|
|
12
|
+
"docsRoot": "src/app/docs"
|
|
13
|
+
},
|
|
14
|
+
"site": {
|
|
15
|
+
"name": "Farm App Docs"
|
|
16
|
+
},
|
|
17
|
+
"metadata": {
|
|
18
|
+
"description": "Documentation for your Farm.js app."
|
|
19
|
+
},
|
|
20
|
+
"nav": {
|
|
21
|
+
"title": "Farm App",
|
|
22
|
+
"url": "/"
|
|
23
|
+
},
|
|
24
|
+
"search": {
|
|
25
|
+
"provider": "simple",
|
|
26
|
+
"enabled": true,
|
|
27
|
+
"maxResults": 12
|
|
28
|
+
},
|
|
29
|
+
"llmsTxt": {
|
|
30
|
+
"enabled": true,
|
|
31
|
+
"siteTitle": "Farm App Docs",
|
|
32
|
+
"siteDescription": "Documentation for your Farm.js app."
|
|
33
|
+
},
|
|
34
|
+
"sitemap": true,
|
|
35
|
+
"robots": true
|
|
36
|
+
}
|
|
@@ -7,6 +7,12 @@ export default defineConfig({
|
|
|
7
7
|
theme: {
|
|
8
8
|
default: "dark",
|
|
9
9
|
},
|
|
10
|
+
// Docs are powered by the @farming-labs/farmjs framework. Farm auto-detects
|
|
11
|
+
// the installed adapter and reads docs.config.ts (docs.json is kept as a
|
|
12
|
+
// language-agnostic fallback/manifest); content lives in src/app/docs.
|
|
13
|
+
docs: {
|
|
14
|
+
enabled: true,
|
|
15
|
+
},
|
|
10
16
|
experimental: {
|
|
11
17
|
serverComponents: true,
|
|
12
18
|
},
|
|
@@ -10,8 +10,11 @@
|
|
|
10
10
|
"type-check": "tsc --noEmit"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@farm.js/better-auth": "0.1.0-beta.
|
|
14
|
-
"@farm.js/core": "0.1.0-beta.
|
|
13
|
+
"@farm.js/better-auth": "0.1.0-beta.63",
|
|
14
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
15
|
+
"@farming-labs/docs": "0.2.111",
|
|
16
|
+
"@farming-labs/farmjs": "0.2.111",
|
|
17
|
+
"@farming-labs/theme": "0.2.111",
|
|
15
18
|
"@fontsource-variable/geist": "5.3.0",
|
|
16
19
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
17
20
|
"better-auth": "1.6.25",
|
|
@@ -21,7 +24,7 @@
|
|
|
21
24
|
"react-dom": "^19.0.0"
|
|
22
25
|
},
|
|
23
26
|
"devDependencies": {
|
|
24
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
27
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
25
28
|
"@types/node": "20.19.9",
|
|
26
29
|
"@types/pg": "8.20.0",
|
|
27
30
|
"@types/react": "^19.0.0",
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Getting Started"
|
|
3
|
+
description: "Your Farm.js documentation, powered by the @farming-labs/farmjs docs framework."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Getting Started
|
|
7
|
+
|
|
8
|
+
These docs are served by the Farm docs runtime, powered by the
|
|
9
|
+
[@farming-labs/farmjs](https://www.npmjs.com/package/@farming-labs/farmjs) docs
|
|
10
|
+
framework. The same Markdown files power human pages, Markdown routes,
|
|
11
|
+
`llms.txt`, the sitemap, search, and agent discovery through `/api/docs`.
|
|
12
|
+
|
|
13
|
+
## Edit this page
|
|
14
|
+
|
|
15
|
+
This page lives at `src/app/docs/page.md`. Add more pages as folders with their
|
|
16
|
+
own `page.md` — for example `src/app/docs/configuration/page.md` is served at
|
|
17
|
+
`/docs/configuration`.
|
|
18
|
+
|
|
19
|
+
## Configure
|
|
20
|
+
|
|
21
|
+
Site-wide docs settings live in `docs.config.ts` at the project root (title,
|
|
22
|
+
navigation, search, `llms.txt`, sitemap, and robots). Farm auto-detects the
|
|
23
|
+
installed adapter because `farm.config.ts` sets `docs: { enabled: true }` — no
|
|
24
|
+
manual wiring required.
|
|
25
|
+
|
|
26
|
+
## Learn more
|
|
27
|
+
|
|
28
|
+
- [Farm.js documentation](https://farm.js.dev/docs)
|
|
29
|
+
- [Configuration guide](https://farm.js.dev/docs/configuration)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { defineDocs } from "@farming-labs/docs";
|
|
2
|
+
|
|
3
|
+
// Site-wide docs configuration, powered by the @farming-labs/farmjs framework.
|
|
4
|
+
// Farm auto-detects the installed adapter (because farm.config.ts sets
|
|
5
|
+
// `docs: { enabled: true }`), loads this file, and serves Markdown from
|
|
6
|
+
// src/app/docs.
|
|
7
|
+
//
|
|
8
|
+
// This typed config takes priority over docs.json. Keep docs.json in sync as
|
|
9
|
+
// the language-agnostic manifest: it is the fallback for frameworkless / non
|
|
10
|
+
// JS-TS setups and the source the docs cloud reads.
|
|
11
|
+
export default defineDocs({
|
|
12
|
+
entry: "docs",
|
|
13
|
+
docsPath: "/docs",
|
|
14
|
+
metadata: {
|
|
15
|
+
description: "Documentation for your Farm.js app.",
|
|
16
|
+
},
|
|
17
|
+
nav: {
|
|
18
|
+
title: "Farm App",
|
|
19
|
+
url: "/",
|
|
20
|
+
},
|
|
21
|
+
search: {
|
|
22
|
+
provider: "simple",
|
|
23
|
+
enabled: true,
|
|
24
|
+
maxResults: 12,
|
|
25
|
+
},
|
|
26
|
+
llmsTxt: {
|
|
27
|
+
enabled: true,
|
|
28
|
+
siteTitle: "Farm App Docs",
|
|
29
|
+
siteDescription: "Documentation for your Farm.js app.",
|
|
30
|
+
},
|
|
31
|
+
sitemap: true,
|
|
32
|
+
robots: true,
|
|
33
|
+
});
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://docs.farming-labs.dev/schema/docs.json",
|
|
3
|
+
"version": 1,
|
|
4
|
+
"entry": "docs",
|
|
5
|
+
"docsPath": "/docs",
|
|
6
|
+
"docs": {
|
|
7
|
+
"mode": "framework",
|
|
8
|
+
"runtime": "farm",
|
|
9
|
+
"root": "."
|
|
10
|
+
},
|
|
11
|
+
"content": {
|
|
12
|
+
"docsRoot": "src/app/docs"
|
|
13
|
+
},
|
|
14
|
+
"site": {
|
|
15
|
+
"name": "Farm App Docs"
|
|
16
|
+
},
|
|
17
|
+
"metadata": {
|
|
18
|
+
"description": "Documentation for your Farm.js app."
|
|
19
|
+
},
|
|
20
|
+
"nav": {
|
|
21
|
+
"title": "Farm App",
|
|
22
|
+
"url": "/"
|
|
23
|
+
},
|
|
24
|
+
"search": {
|
|
25
|
+
"provider": "simple",
|
|
26
|
+
"enabled": true,
|
|
27
|
+
"maxResults": 12
|
|
28
|
+
},
|
|
29
|
+
"llmsTxt": {
|
|
30
|
+
"enabled": true,
|
|
31
|
+
"siteTitle": "Farm App Docs",
|
|
32
|
+
"siteDescription": "Documentation for your Farm.js app."
|
|
33
|
+
},
|
|
34
|
+
"sitemap": true,
|
|
35
|
+
"robots": true
|
|
36
|
+
}
|
|
@@ -17,6 +17,12 @@ export default defineConfig({
|
|
|
17
17
|
theme: {
|
|
18
18
|
default: "dark",
|
|
19
19
|
},
|
|
20
|
+
// Docs are powered by the @farming-labs/farmjs framework. Farm auto-detects
|
|
21
|
+
// the installed adapter and reads docs.config.ts (docs.json is kept as a
|
|
22
|
+
// language-agnostic fallback/manifest); content lives in src/app/docs.
|
|
23
|
+
docs: {
|
|
24
|
+
enabled: true,
|
|
25
|
+
},
|
|
20
26
|
deploy: {
|
|
21
27
|
target: "node",
|
|
22
28
|
},
|
|
@@ -11,15 +11,18 @@
|
|
|
11
11
|
"type-check": "tsc --noEmit"
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@farm.js/core": "0.1.0-beta.
|
|
14
|
+
"@farm.js/core": "0.1.0-beta.63",
|
|
15
15
|
"@farm.js/react": "0.1.0-beta.3",
|
|
16
|
+
"@farming-labs/docs": "0.2.111",
|
|
17
|
+
"@farming-labs/farmjs": "0.2.111",
|
|
18
|
+
"@farming-labs/theme": "0.2.111",
|
|
16
19
|
"@fontsource-variable/geist": "5.3.0",
|
|
17
20
|
"@fontsource-variable/geist-mono": "5.3.0",
|
|
18
21
|
"react": "19.2.8",
|
|
19
22
|
"react-dom": "19.2.8"
|
|
20
23
|
},
|
|
21
24
|
"devDependencies": {
|
|
22
|
-
"@farm.js/cli": "0.1.0-beta.
|
|
25
|
+
"@farm.js/cli": "0.1.0-beta.63",
|
|
23
26
|
"@playwright/test": "^1.52.0",
|
|
24
27
|
"@types/react": "^19.0.0",
|
|
25
28
|
"@types/react-dom": "^19.0.0",
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Getting Started"
|
|
3
|
+
description: "Your Farm.js documentation, powered by the @farming-labs/farmjs docs framework."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Getting Started
|
|
7
|
+
|
|
8
|
+
These docs are served by the Farm docs runtime, powered by the
|
|
9
|
+
[@farming-labs/farmjs](https://www.npmjs.com/package/@farming-labs/farmjs) docs
|
|
10
|
+
framework. The same Markdown files power human pages, Markdown routes,
|
|
11
|
+
`llms.txt`, the sitemap, search, and agent discovery through `/api/docs`.
|
|
12
|
+
|
|
13
|
+
## Edit this page
|
|
14
|
+
|
|
15
|
+
This page lives at `src/app/docs/page.md`. Add more pages as folders with their
|
|
16
|
+
own `page.md` — for example `src/app/docs/configuration/page.md` is served at
|
|
17
|
+
`/docs/configuration`.
|
|
18
|
+
|
|
19
|
+
## Configure
|
|
20
|
+
|
|
21
|
+
Site-wide docs settings live in `docs.config.ts` at the project root (title,
|
|
22
|
+
navigation, search, `llms.txt`, sitemap, and robots). Farm auto-detects the
|
|
23
|
+
installed adapter because `farm.config.ts` sets `docs: { enabled: true }` — no
|
|
24
|
+
manual wiring required.
|
|
25
|
+
|
|
26
|
+
## Learn more
|
|
27
|
+
|
|
28
|
+
- [Farm.js documentation](https://farm.js.dev/docs)
|
|
29
|
+
- [Configuration guide](https://farm.js.dev/docs/configuration)
|