Skip to content

Commit 4cf430e

Browse files
authored
[docs] Add llms.txt files (#332)
1 parent 6980e89 commit 4cf430e

File tree

5 files changed

+119
-67
lines changed

5 files changed

+119
-67
lines changed

.changeset/lovely-areas-follow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"docs2": minor
3+
---
4+
5+
Add `llms.txt` files

apps/docs2/astro.config.mjs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import starlight from "@astrojs/starlight";
55
import svelte from "@astrojs/svelte";
66
import starlightLinksValidator from "starlight-links-validator";
77
import { visit } from "unist-util-visit";
8+
import starlightLlmsTxt from "starlight-llms-txt";
89

910
const base = "/svelte-jsonschema-form/";
1011

@@ -40,7 +41,12 @@ export default defineConfig({
4041
svelte(),
4142
starlight({
4243
// favicon: "src/assets/logo.svg",
43-
plugins: process.env.CHECK_LINKS ? [starlightLinksValidator()] : [],
44+
plugins: [
45+
starlightLlmsTxt({
46+
rawContent: true,
47+
exclude: ["404", "changelogs/**", "examples/**"],
48+
}),
49+
].concat(process.env.CHECK_LINKS ? [starlightLinksValidator()] : []),
4450
title: "svelte-jsonschema-form v3",
4551
// logo: {
4652
// src: "./src/assets/logo.svg",

apps/docs2/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
"json-schema-to-ts": "^3.1.1",
9090
"sharp": "^0.34.5",
9191
"starlight-links-validator": "^0.19.2",
92+
"starlight-llms-txt": "^0.7.0",
9293
"starlight-package-managers": "^0.12.0",
9394
"svelte": "catalog:",
9495
"unist-util-visit": "^5.1.0"

apps/docs2/src/content/docs/misc/llms.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,14 @@ sidebar:
44
order: 200
55
---
66

7-
At the moment, the `llms.txt` file is missing (contributions are welcome).
8-
However, you can use the following third-party services for working with LLMs:
7+
The `llms.txt` files were generated using [starlight-llms-txt](https://github.com/delucis/starlight-llms-txt).
8+
Their usefulness is somewhat limited because the code from some snippets is not inlined (contributions are welcome).
9+
10+
- [llms.txt](/llms.txt)
11+
- [llms-small.txt](/llms-small.txt)
12+
- [llms-full.txt](/llms-full.txt)
13+
14+
You can also use the following third-party services for working with LLMs:
915

1016
- [Context7](https://context7.com/x0k/svelte-jsonschema-form)
1117
- [DeepWiki](https://deepwiki.com/x0k/svelte-jsonschema-form)

pnpm-lock.yaml

Lines changed: 98 additions & 64 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)