svelte-docsmith 0.4.0 → 0.5.0

package/dist/vite.js

@@ -12,6 +12,7 @@
  *  3. The **`?source` transform** powering `LiveExample`: importing
  *     `Component.svelte?source` yields that file's Shiki-highlighted source.
  */
+import { spawnSync } from 'node:child_process';
 import fs from 'node:fs';
 import path from 'node:path';
 import GithubSlugger from 'github-slugger';
@@ -33,6 +34,8 @@ const CONTENT_SPECIFIER = 'svelte-docsmith/content';
 const VIRTUAL_CONTENT_ID = '\0svelte-docsmith:content';
 const SEARCH_SPECIFIER = 'svelte-docsmith/search';
 const VIRTUAL_SEARCH_ID = '\0svelte-docsmith:search';
+const LLMS_SPECIFIER = 'svelte-docsmith/llms';
+const VIRTUAL_LLMS_ID = '\0svelte-docsmith:llms';
 const PAGE_NAMES = ['+page.md', '+page.svx'];
 function isPageFile(file) {
     return PAGE_NAMES.some((name) => file.endsWith(name));
@@ -138,6 +141,15 @@ function extractToc(source) {
     }
     return toc;
 }
+/** Last git commit date (strict ISO) for a file, or undefined outside a repo. */
+function lastCommitDate(file) {
+    const res = spawnSync('git', ['log', '-1', '--format=%cI', '--', file], {
+        cwd: path.dirname(file),
+        encoding: 'utf-8'
+    });
+    const date = res.status === 0 ? res.stdout.trim() : '';
+    return date || undefined;
+}
 /**
  * Walk every nav-worthy page under `contentDir` once: a page is nav-worthy when
  * its frontmatter has a string `title`. Yields the raw source, parsed
@@ -152,7 +164,7 @@ function* eachTitledPage(contentDir, routesDir) {
             continue;
         const dir = path.dirname(file);
         const url = '/' + path.relative(routesDir, dir).split(path.sep).join('/');
-        yield { source, front, url, title: front.title };
+        yield { source, front, url, title: front.title, file };
     }
 }
 export function collectDocs(contentDir, routesDir) {
@@ -162,13 +174,15 @@ export function collectDocs(contentDir, routesDir) {
         return [];
     }
     const items = [];
-    for (const { source, front, url, title } of eachTitledPage(contentDir, routesDir)) {
+    for (const { source, front, url, title, file } of eachTitledPage(contentDir, routesDir)) {
         items.push({
             title,
             path: url,
             description: typeof front.description === 'string' ? front.description : undefined,
             section: typeof front.section === 'string' ? front.section : undefined,
             order: typeof front.order === 'number' ? front.order : undefined,
+            sourcePath: path.relative(process.cwd(), file).split(path.sep).join('/'),
+            lastUpdated: lastCommitDate(file),
             toc: extractToc(source)
         });
     }
@@ -202,6 +216,41 @@ export function collectSearchDocs(contentDir, routesDir) {
     }
     return docs.sort((a, b) => a.path.localeCompare(b.path));
 }
+/**
+ * The page's markdown body for LLM output: frontmatter and `<script>`/`<style>`
+ * blocks removed, everything else (headings, prose, code, component tags) kept,
+ * with the frontmatter title prepended as an `h1` (pages start their body at h2).
+ */
+function extractLlmsContent(source, title) {
+    const body = source
+        .replace(/^---\r?\n[\s\S]*?\r?\n---\r?\n?/, '')
+        .replace(/<script[\s\S]*?<\/script>/gi, '')
+        .replace(/<style[\s\S]*?<\/style>/gi, '')
+        .trim();
+    return `# ${title}\n\n${body}`;
+}
+/**
+ * Build the LLM records for every page: title, section, description, and the
+ * full markdown content. Served as the `svelte-docsmith/llms` virtual module and
+ * consumed server-side by `llms.txt` / `llms-full.txt` routes, so it never ships
+ * to the client.
+ */
+export function collectLlmsDocs(contentDir, routesDir) {
+    if (!fs.existsSync(contentDir))
+        return [];
+    const docs = [];
+    for (const { source, front, url, title } of eachTitledPage(contentDir, routesDir)) {
+        docs.push({
+            path: url,
+            title,
+            section: typeof front.section === 'string' ? front.section : undefined,
+            order: typeof front.order === 'number' ? front.order : undefined,
+            description: typeof front.description === 'string' ? front.description : undefined,
+            content: extractLlmsContent(source, title)
+        });
+    }
+    return docs.sort((a, b) => a.path.localeCompare(b.path));
+}
 function parseFrontmatter(source, file) {
     const match = /^---\r?\n([\s\S]*?)\r?\n---/.exec(source);
     if (!match)
@@ -227,6 +276,8 @@ function contentIndexPlugin(options) {
                 return VIRTUAL_CONTENT_ID;
             if (id === SEARCH_SPECIFIER)
                 return VIRTUAL_SEARCH_ID;
+            if (id === LLMS_SPECIFIER)
+                return VIRTUAL_LLMS_ID;
         },
         load(id) {
             // Watch each page file (not the directory) so editing frontmatter or
@@ -245,6 +296,12 @@ function contentIndexPlugin(options) {
                 const docs = collectSearchDocs(contentDir, routesDir);
                 return `export const docs = ${JSON.stringify(docs)};\n`;
             }
+            if (id === VIRTUAL_LLMS_ID) {
+                for (const file of listPageFiles(contentDir))
+                    this.addWatchFile(file);
+                const docs = collectLlmsDocs(contentDir, routesDir);
+                return `export const docs = ${JSON.stringify(docs)};\n`;
+            }
         },
         configureServer(server) {
             server.watcher.add(contentDir);
@@ -252,7 +309,7 @@ function contentIndexPlugin(options) {
                 if (!isPageFile(file))
                     return;
                 let invalidated = false;
-                for (const virtualId of [VIRTUAL_CONTENT_ID, VIRTUAL_SEARCH_ID]) {
+                for (const virtualId of [VIRTUAL_CONTENT_ID, VIRTUAL_SEARCH_ID, VIRTUAL_LLMS_ID]) {
                     const mod = server.moduleGraph.getModuleById(virtualId);
                     if (!mod)
                         continue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-docsmith",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A framework for building beautiful documentation sites with Svelte.",
   "author": {
     "name": "George Daskalakis",
@@ -39,6 +39,10 @@
       "types": "./dist/search.d.ts",
       "default": "./dist/search.js"
     },
+    "./llms": {
+      "types": "./dist/llms.d.ts",
+      "default": "./dist/llms.js"
+    },
     "./theme.css": "./dist/theme.css",
     "./themes/*.css": "./dist/themes/*.css",
     "./package.json": "./package.json"
@@ -58,6 +62,7 @@
   },
   "devDependencies": {
     "@internationalized/date": "^3.12.2",
+    "@lucide/svelte": "^1.24.0",
     "@sveltejs/adapter-auto": "^7.0.1",
     "@sveltejs/adapter-vercel": "^6.3.4",
     "@sveltejs/kit": "^2.69.1",
@@ -81,7 +86,6 @@
   "dependencies": {
     "@fontsource-variable/inter": "^5.2.8",
     "@hbsnow/rehype-sectionize": "^1.0.7",
-    "@lucide/svelte": "^1.24.0",
     "@shikijs/transformers": "^3.3.0",
     "@tailwindcss/typography": "^0.5.16",
     "bits-ui": "^2.18.1",
@@ -115,7 +119,6 @@
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
     "test:unit": "vitest run",
-    "typecheck": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-    "size": "size-limit"
+    "typecheck": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
   }
 }