Finish first pass at templates

Author: lucperkins

.github/workflows/update-flake-lock.yml

@@ -59,8 +59,7 @@ jobs:
           committer: github-actions[bot] github-actions[bot]@users.noreply.github.com
           assignees: lucperkins
           reviewers: lucperkins
-          labels:
-            automated
+          labels: automated
             templates
             update
           body: |

.prettierignore

@@ -7,3 +7,4 @@ pnpm-lock.yaml
 **/*.mdx
 src/components/Posthog.astro
 **/*.lock
+**/*.hbs

pnpm-workspace.yaml

@@ -1,2 +1,2 @@
 overrides:
-  devalue@<5.3.2: '>=5.3.2'
+  devalue@<5.3.2: ">=5.3.2"

src/pages/llms-full.txt.ts

@@ -0,0 +1,62 @@
+import { conceptPagePath, startPagePath } from "../lib/utils";
+import { site } from "../site";
+import type { APIRoute } from "astro";
+import { getCollection } from "astro:content";
+import Handlebars from "handlebars";
+import fs from "node:fs";
+import path from "node:path";
+
+const { url: root, title, description: tagline, llms } = site;
+
+const templateFile = fs.readFileSync(
+  path.join(process.cwd(), "src/templates/llms-full.txt.hbs"),
+  "utf-8",
+);
+
+const template = Handlebars.compile(templateFile);
+
+export const GET: APIRoute = async () => {
+  const startPages = await getCollection("start");
+  const conceptPages = await getCollection("concepts");
+
+  const content = template({
+    root,
+    title,
+    system:
+      "This is the complete documentation for Zero to Nix, including the learning journey (start) and concept pages.",
+    instructions:
+      "Learning journey (start) and concept page items begin and end with a --- and all page titles are in bold.",
+    tagline,
+    description: llms.description,
+    startPages: startPages.map(({ data: { title }, slug, body }) => ({
+      title,
+      href: `${root}/${startPagePath(slug)}`,
+      content: body,
+    })),
+    conceptPages: conceptPages.map(({ data: { title }, slug, body }) => ({
+      title,
+      href: `${root}/${conceptPagePath(slug)}`,
+      content: body,
+    })),
+    otherFormats: [
+      {
+        root,
+        file: "llms.txt",
+        description: "the main version",
+      },
+      {
+        root,
+        file: "llms-full.txt",
+        description: "complete content in one file",
+      },
+    ],
+  });
+
+  return new Response(content, {
+    headers: {
+      "Content-Type": "text/plain; charset=utf-8",
+    },
+  });
+};
+
+export const prerender = true;

src/pages/llms-small.txt.ts

@@ -0,0 +1,53 @@
+//import { conceptPagePath, startPagePath } from "../lib/utils";
+import { site } from "../site";
+import type { APIRoute } from "astro";
+import { getCollection } from "astro:content";
+import Handlebars from "handlebars";
+import fs from "node:fs";
+import path from "node:path";
+
+const { url: root, title, llms } = site;
+
+const templateFile = fs.readFileSync(
+  path.join(process.cwd(), "src/templates/llms-small.txt.hbs"),
+  "utf-8",
+);
+
+const template = Handlebars.compile(templateFile);
+
+export const GET: APIRoute = async () => {
+  const startPages = await getCollection("start");
+  const conceptPages = await getCollection("concepts");
+
+  const content = template({
+    root,
+    title,
+    description: llms.description,
+    startPages: startPages.map(({ data: { title } }) => ({
+      title,
+    })),
+    conceptPages: conceptPages.map(({ data: { title } }) => ({
+      title,
+    })),
+    otherFormats: [
+      {
+        root,
+        file: "llms.txt",
+        description: "the main version",
+      },
+      {
+        root,
+        file: "llms-full.txt",
+        description: "complete content in one file",
+      },
+    ],
+  });
+
+  return new Response(content, {
+    headers: {
+      "Content-Type": "text/plain; charset=utf-8",
+    },
+  });
+};
+
+export const prerender = true;

src/templates/llms-full.txt.hbs

@@ -0,0 +1,55 @@
+<SYSTEM>{{system}}</SYSTEM>
+
+<INSTRUCTIONS>{{instructions}}</INSTRUCTIONS>
+
+# {{title}}
+
+> {{tagline}}
+
+{{description}}
+
+## Start pages
+
+---
+
+{{#each startPages}}
+**{{{this.title}}}**
+
+Published: {{this.date}}
+URL: {{this.href}}
+
+{{{this.content}}}
+
+{{#unless @last}}
+---
+
+{{/unless}}
+{{/each}}
+---
+
+## Concept pages
+
+---
+
+{{#each conceptPages}}
+**{{{this.title}}}**
+
+Published: {{this.date}}
+URL: {{this.href}}
+
+{{{this.content}}}
+
+{{#unless @last}}
+---
+
+{{/unless}}
+{{/each}}
+---
+
+## Other formats
+
+For other documentation formats, see also:
+
+{{#each otherFormats}}
+- [`{{this.file}}`]({{root}}/{{this.file}}) ({{this.description}})
+{{/each}}

src/templates/llms-small.txt.hbs

@@ -0,0 +1,25 @@
+# {{title}}
+
+{{description}}
+
+## Start pages These pages take you on a Nix journey from installing Nix through
+accomplishing meaningful tasks with Nix:
+
+{{#each startPages}}
+- {{this.title}}
+{{/each}}
+
+## Concept pages These pages provide a more theoretical take on some of the
+trickier corners of Nix:
+
+{{#each conceptPages}}
+- {{this.title}}
+{{/each}}
+
+## Other formats
+
+For other documentation formats, see also:
+
+{{#each otherFormats}}
+- [`{{this.file}}`]({{root}}/{{this.file}}) ({{this.description}})
+{{/each}}

src/templates/llms.txt.hbs

@@ -6,19 +6,25 @@
 
 ## Start pages
 
+These pages take you on a Nix journey from installing Nix through
+accomplishing meaningful tasks with Nix:
+
 {{#each startPages}}
 - [{{this.title}}]({{this.href}})
 {{/each}}
 
 ## Concept pages
 
+These pages provide a more theoretical take on some of the
+trickier corners of Nix:
+
 {{#each conceptPages}}
 - [{{this.title}}]({{this.href}})
 {{/each}}
 
 ## Other formats
 
-For more detailed documentation, see also:
+For other documentation formats, see also:
 
 {{#each otherFormats}}
 - [`{{this.file}}`]({{root}}/{{this.file}}) ({{this.description}})