Skip to content

Commit d7c8bed

Browse files
committed
fix: links in llms.txt
1 parent 8458157 commit d7c8bed

File tree

6 files changed

+66
-28
lines changed

6 files changed

+66
-28
lines changed

package-lock.json

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"@fortawesome/free-solid-svg-icons": "^7.1.0",
3535
"@jridgewell/source-map": "^0.3.11",
3636
"@marko/run": "^0.9.3",
37-
"@marko/run-adapter-static": "^2.0.3",
37+
"@marko/run-adapter-static": "^2.0.4",
3838
"@marko/type-check": "^2.1.11",
3939
"@rollup/browser": "^4.53.3",
4040
"@shikijs/langs": "^3.15.0",

public/llms.txt

Lines changed: 45 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,56 @@ Marko's key features include:
1111
- Zero-JS-by-default with sub-component partial hydration
1212

1313
## Full Documentation
14-
- [Reference Documentation](/docs/reference-full.md): Official documentation site for Marko
14+
- [Reference Documentation](/docs/reference-full.md): Complete reference documentation
1515

16-
## Reference Documentation
16+
## Introduction
1717

18-
- [Why Choose Marko](/docs/explanation/why-marko.md): Performance benefits, developer experience, and core principles
19-
- [Language Reference](/docs/reference/language.md): Complete language syntax and features documentation
20-
- [Core Tags](/docs/reference/core-tag.md): Built-in Marko tags and their functionality
21-
- [Native Tags](/docs/reference/native-tag.md): How HTML tags work in Marko
22-
- [Custom Tags](/docs/reference/custom-tag.md): Creating and using custom components
23-
- [Reactivity](/docs/reference/reactivity.md): Understanding Marko's reactive system
24-
- [TypeScript Support](/docs/reference/typescript.md): Using TypeScript with Marko
25-
- [Template API](/docs/reference/template.md): API reference for Marko templates
26-
- [Concise Syntax](/docs/reference/concise-syntax.md): Alternative compact syntax for Marko templates
27-
- [TypeScript](/docs/reference/typescript.md): Detailed TypeScript setup and configuration
18+
- [Getting Started](/docs/introduction/getting-started.md): Quick start guide for new projects
19+
- [Welcome to Marko](/docs/introduction/welcome-to-marko.md): Introduction to the framework
20+
- [Installation](/docs/introduction/installation.md): Installation and setup
21+
- [Why Marko](/docs/introduction/why-marko.md): Performance benefits and core principles
22+
- [Integrations](/docs/introduction/integrations.md): Integration with other tools
23+
24+
## Tutorials
25+
26+
- [Fundamentals](/docs/tutorial/fundamentals.md): Core concepts and syntax
27+
- [Components and Reactivity](/docs/tutorial/components-and-reactivity.md): Building interactive components
2828

2929
## Guides
3030

31-
- [Getting Started](/docs/introduction/getting-started.md): Quick start guide for new projects
32-
- [Styling](/docs/guide/styling.md): Guide to styling in Marko applications
33-
- [File-based Routing](/docs/marko-run/file-based-routing.md): How routing works in Marko applications
31+
- [Styling](/docs/guide/styling.md): Styling in Marko applications
32+
- [Library Integration](/docs/guide/library-integration.md): Using third-party libraries
33+
- [Publishing Components](/docs/guide/publishing-components.md): Publishing reusable components
34+
- [Low-level APIs](/docs/guide/low-level-apis.md): Advanced low-level APIs
35+
- [Duplicate Form Submissions](/docs/guide/duplicate-form-submissions.md): Preventing duplicate submissions
36+
- [Marko 5 Interop](/docs/guide/marko-5-interop.md): Interoperability with Marko 5
37+
38+
## Explanation
39+
40+
- [Streaming](/docs/explanation/streaming.md): Streaming server-side rendering
41+
- [Targeted Compilation](/docs/explanation/targeted-compilation.md): Compilation strategy
42+
- [Fine-grained Bundling](/docs/explanation/fine-grained-bundling.md): Automatic code splitting
43+
- [Separation of Concerns](/docs/explanation/separation-of-concerns.md): Architectural patterns
44+
- [Controllable Components](/docs/explanation/controllable-components.md): Controllable component patterns
45+
- [Nested Reactivity](/docs/explanation/nested-reactivity.md): Nested reactive data
46+
- [Immutable State](/docs/explanation/immutable-state.md): Immutability in reactivity
47+
- [Serializable State](/docs/explanation/serializable-state.md): State serialization
48+
- [Let vs Const](/docs/explanation/let-vs-const.md): Reactive declarations
49+
- [Optimizing Performance](/docs/explanation/optimizing-performance.md): Performance optimization
50+
51+
## Reference
52+
53+
- [Language](/docs/reference/language.md): Complete language syntax and features
54+
- [Custom Tags](/docs/reference/custom-tag.md): Creating custom components
55+
- [Reactivity](/docs/reference/reactivity.md): Reactive system API
56+
- [Core Tags](/docs/reference/core-tag.md): Built-in Marko tags
57+
- [Native Tags](/docs/reference/native-tag.md): HTML tags in Marko
58+
- [TypeScript](/docs/reference/typescript.md): TypeScript integration
59+
- [Concise Syntax](/docs/reference/concise-syntax.md): Alternative compact syntax
60+
- [Template API](/docs/reference/template.md): Template rendering API
3461

3562
## Marko Run
3663

37-
- [Getting Started](/docs/run/getting-started.md): Quick start guide for Marko Run
38-
- [File-based Routing](/docs/run/file-based-routing.md): How routing works in Marko Run
39-
- [Concise Syntax](/docs/run/typescript.md): Using TypeScript with Marko Run
64+
- [Getting Started](/docs/marko-run/getting-started.md): Quick start for Marko Run
65+
- [File-based Routing](/docs/marko-run/file-based-routing.md): Routing in Marko Run
66+
- [TypeScript](/docs/marko-run/typescript.md): TypeScript with Marko Run

src/routes/docs/_llms/prepare-llmstxt.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ export default function (title: string, files: string[]) {
44
return (
55
`<SYSTEM>${title}</SYSTEM>\n\n----------\n\n` +
66
files
7-
.map((filename) => fs.readFileSync(filename))
7+
.map(
8+
(filename) =>
9+
`<!-- ${filename.slice(filename.lastIndexOf("/") + 1)} -->\n\n${fs.readFileSync(filename)}`,
10+
)
811
.join("\n\n----------\n\n")
912
);
1013
}

src/routes/docs/_llms/reference-full%2emd+handler.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
import path from "node:path";
22
import prepareLlmsTxt from "./prepare-llmstxt";
3-
import fs from "node:fs";
43

54
const referenceDir = path.join(process.cwd(), "docs", "reference");
65
const referenceDocs = prepareLlmsTxt(
76
"This is the reference documentation for the Marko Language & JavaScript Framework",
8-
fs.readdirSync(referenceDir).map((file) => path.join(referenceDir, file)),
7+
[
8+
"language",
9+
"custom-tag",
10+
"reactivity",
11+
"core-tag",
12+
"native-tag",
13+
"typescript",
14+
"concise-syntax",
15+
"template",
16+
].map((file) => path.join(referenceDir, file + ".md")),
917
);
1018

1119
export const GET = (() => {

src/tags/app-menu/app-menu.marko

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ div#site-menu class=styles.menu
5656
Page="/docs/reference/reactivity" -- Reactivity
5757
Page="/docs/reference/core-tag" -- Core Tags
5858
Page="/docs/reference/native-tag" -- Native Tags
59-
Page="/docs/reference/concise-syntax" -- Concise Syntax
60-
Page="/docs/reference/template" -- Template API
6159
Page="/docs/reference/typescript" -- TypeScript
60+
Page="/docs/reference/template" -- Template API
61+
Page="/docs/reference/concise-syntax" -- Concise Syntax
6262
li
6363
strong -- Marko Run
6464
ul

0 commit comments

Comments
 (0)