@lacspace/llms-txt 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lacspace
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+<div align="center">
+
+# @lacspace/llms-txt
+
+**Generate & parse `llms.txt` and `llms-full.txt` — the [llmstxt.org](https://llmstxt.org) standard.**
+
+[![npm version](https://img.shields.io/npm/v/@lacspace/llms-txt?color=%2322c55e&label=npm)](https://www.npmjs.com/package/@lacspace/llms-txt)
+[![install size](https://packagephobia.com/badge?p=@lacspace/llms-txt)](https://packagephobia.com/result?p=@lacspace/llms-txt)
+[![minzipped](https://img.shields.io/bundlephobia/minzip/@lacspace/llms-txt?label=minzip)](https://bundlephobia.com/package/@lacspace/llms-txt)
+[![types](https://img.shields.io/badge/types-included-blue)](https://www.npmjs.com/package/@lacspace/llms-txt)
+[![license](https://img.shields.io/npm/l/@lacspace/llms-txt?color=green)](https://github.com/lacspace/npm-packages/blob/main/LICENSE)
+
+</div>
+
+> `llms.txt` is a Markdown file at your site root that gives LLMs a curated map of your most useful pages; `llms-full.txt` inlines the full content so a model can read everything in one request. This builds (and parses) both — the SEO layer for the AI era.
+
+- 📄 `llmsTxt()` — H1 title, blockquote summary, linked sections
+- 📚 `llmsFullTxt()` — full content inlined for one-shot ingestion
+- 🔁 `parseLlmsTxt()` — read an existing file back into structured data
+- ⚡ Zero dependencies · 🌍 isomorphic · 📦 ESM + CJS · fully typed
+
+## Install
+
+```bash
+npm install @lacspace/llms-txt      # or pnpm add / yarn add / bun add
+```
+
+## Generate `llms.txt`
+
+```ts
+import { llmsTxt } from "@lacspace/llms-txt";
+
+const txt = llmsTxt({
+  title: "Lacspace",
+  summary: "Open-source TypeScript packages and products.",
+  details: "Zero-dependency, isomorphic, MIT-licensed.",
+  sections: [
+    {
+      title: "Docs",
+      links: [
+        { title: "npm Packages", url: "https://lacspace.com/packages", notes: "20 packages" },
+        { title: "SDK", url: "https://www.npmjs.com/package/@lacspace/sdk" },
+      ],
+    },
+  ],
+});
+```
+
+```markdown
+# Lacspace
+
+> Open-source TypeScript packages and products.
+
+Zero-dependency, isomorphic, MIT-licensed.
+
+## Docs
+
+- [npm Packages](https://lacspace.com/packages): 20 packages
+- [SDK](https://www.npmjs.com/package/@lacspace/sdk)
+```
+
+## Generate `llms-full.txt`
+
+```ts
+import { llmsFullTxt } from "@lacspace/llms-txt";
+
+llmsFullTxt({
+  title: "Lacspace Docs",
+  sections: [
+    { title: "Getting started", url: "https://lacspace.com/docs", content: "# Getting started\n\nInstall with npm…" },
+  ],
+});
+```
+
+## Parse
+
+```ts
+import { parseLlmsTxt } from "@lacspace/llms-txt";
+
+const doc = parseLlmsTxt(existing); // { title, summary, details, sections: [{ title, links }] }
+```
+
+> Serve `llmsTxt(...)` at `/llms.txt` and `llmsFullTxt(...)` at `/llms-full.txt` (e.g. from a Next.js Route Handler or any static build step).
+
+## The Lacspace SEO Kit
+
+| Package | For |
+| --- | --- |
+| [`@lacspace/seo`](https://www.npmjs.com/package/@lacspace/seo) | Metadata & JSON-LD |
+| [`@lacspace/sitemap`](https://www.npmjs.com/package/@lacspace/sitemap) | sitemap.xml |
+| [`@lacspace/robots`](https://www.npmjs.com/package/@lacspace/robots) | robots.txt |
+| **`@lacspace/llms-txt`** | llms.txt / llms-full.txt (this package) |
+| [`@lacspace/site-verify`](https://www.npmjs.com/package/@lacspace/site-verify) | Search-engine verification |
+| [`@lacspace/rss`](https://www.npmjs.com/package/@lacspace/rss) | RSS / Atom / JSON feeds |
+| [`@lacspace/slugify`](https://www.npmjs.com/package/@lacspace/slugify) | SEO URL slugs |
+
+<div align="center"><sub>Built with care by <a href="https://lacspace.com">Lacspace</a> · MIT licensed · <a href="https://github.com/lacspace/npm-packages">source</a></sub></div>

package/dist/index.cjs

@@ -0,0 +1,57 @@
+'use strict';
+
+// src/index.ts
+function llmsTxt(doc) {
+  const out = [`# ${doc.title}`];
+  if (doc.summary) out.push("", `> ${doc.summary}`);
+  if (doc.details) out.push("", doc.details.trim());
+  for (const section of doc.sections) {
+    out.push("", `## ${section.title}`, "");
+    for (const l of section.links) {
+      out.push(`- [${l.title}](${l.url})${l.notes ? `: ${l.notes}` : ""}`);
+    }
+  }
+  return out.join("\n") + "\n";
+}
+function llmsFullTxt(doc) {
+  const out = [`# ${doc.title}`];
+  if (doc.summary) out.push("", `> ${doc.summary}`);
+  for (const section of doc.sections) {
+    out.push("", "---", "", `## ${section.title}`);
+    if (section.url) out.push("", `Source: ${section.url}`);
+    out.push("", section.content.trim());
+  }
+  return out.join("\n") + "\n";
+}
+function parseLlmsTxt(txt) {
+  const lines = txt.split(/\r?\n/);
+  const doc = { title: "", sections: [] };
+  let current = null;
+  const detailBuf = [];
+  const linkRe = /^-\s*\[([^\]]+)\]\(([^)]+)\)\s*(?::\s*(.*))?$/;
+  for (const raw of lines) {
+    const line = raw.trimEnd();
+    if (line.startsWith("# ")) {
+      doc.title = line.slice(2).trim();
+    } else if (line.startsWith("> ")) {
+      doc.summary = (doc.summary ? doc.summary + " " : "") + line.slice(2).trim();
+    } else if (line.startsWith("## ")) {
+      current = { title: line.slice(3).trim(), links: [] };
+      doc.sections.push(current);
+    } else if (current && linkRe.test(line)) {
+      const m = line.match(linkRe);
+      current.links.push({ title: m[1], url: m[2], notes: m[3]?.trim() || void 0 });
+    } else if (!current && line && !line.startsWith("#")) {
+      detailBuf.push(line);
+    }
+  }
+  const details = detailBuf.join("\n").trim();
+  if (details) doc.details = details;
+  return doc;
+}
+
+exports.llmsFullTxt = llmsFullTxt;
+exports.llmsTxt = llmsTxt;
+exports.parseLlmsTxt = parseLlmsTxt;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AA0CO,SAAS,QAAQ,GAAA,EAAsB;AAC5C,EAAA,MAAM,GAAA,GAAgB,CAAC,CAAA,EAAA,EAAK,GAAA,CAAI,KAAK,CAAA,CAAE,CAAA;AACvC,EAAA,IAAI,GAAA,CAAI,SAAS,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,EAAA,EAAK,GAAA,CAAI,OAAO,CAAA,CAAE,CAAA;AAChD,EAAA,IAAI,GAAA,CAAI,SAAS,GAAA,CAAI,IAAA,CAAK,IAAI,GAAA,CAAI,OAAA,CAAQ,MAAM,CAAA;AAChD,EAAA,KAAA,MAAW,OAAA,IAAW,IAAI,QAAA,EAAU;AAClC,IAAA,GAAA,CAAI,KAAK,EAAA,EAAI,CAAA,GAAA,EAAM,OAAA,CAAQ,KAAK,IAAI,EAAE,CAAA;AACtC,IAAA,KAAA,MAAW,CAAA,IAAK,QAAQ,KAAA,EAAO;AAC7B,MAAA,GAAA,CAAI,IAAA,CAAK,CAAA,GAAA,EAAM,CAAA,CAAE,KAAK,KAAK,CAAA,CAAE,GAAG,CAAA,CAAA,EAAI,CAAA,CAAE,QAAQ,CAAA,EAAA,EAAK,CAAA,CAAE,KAAK,CAAA,CAAA,GAAK,EAAE,CAAA,CAAE,CAAA;AAAA,IACrE;AAAA,EACF;AACA,EAAA,OAAO,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,GAAI,IAAA;AAC1B;AAiBO,SAAS,YAAY,GAAA,EAA0B;AACpD,EAAA,MAAM,GAAA,GAAgB,CAAC,CAAA,EAAA,EAAK,GAAA,CAAI,KAAK,CAAA,CAAE,CAAA;AACvC,EAAA,IAAI,GAAA,CAAI,SAAS,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,EAAA,EAAK,GAAA,CAAI,OAAO,CAAA,CAAE,CAAA;AAChD,EAAA,KAAA,MAAW,OAAA,IAAW,IAAI,QAAA,EAAU;AAClC,IAAA,GAAA,CAAI,KAAK,EAAA,EAAI,KAAA,EAAO,IAAI,CAAA,GAAA,EAAM,OAAA,CAAQ,KAAK,CAAA,CAAE,CAAA;AAC7C,IAAA,IAAI,OAAA,CAAQ,KAAK,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,GAAG,CAAA,CAAE,CAAA;AACtD,IAAA,GAAA,CAAI,IAAA,CAAK,EAAA,EAAI,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAA;AAAA,EACrC;AACA,EAAA,OAAO,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,GAAI,IAAA;AAC1B;AAGO,SAAS,aAAa,GAAA,EAAsB;AACjD,EAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,KAAA,CAAM,OAAO,CAAA;AAC/B,EAAA,MAAM,MAAe,EAAE,KAAA,EAAO,EAAA,EAAI,QAAA,EAAU,EAAC,EAAE;AAC/C,EAAA,IAAI,OAAA,GAA8B,IAAA;AAClC,EAAA,MAAM,YAAsB,EAAC;AAC7B,EAAA,MAAM,MAAA,GAAS,+CAAA;AAEf,EAAA,KAAA,MAAW,OAAO,KAAA,EAAO;AACvB,IAAA,MAAM,IAAA,GAAO,IAAI,OAAA,EAAQ;AACzB,IAAA,IAAI,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,EAAG;AACzB,MAAA,GAAA,CAAI,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,CAAC,EAAE,IAAA,EAAK;AAAA,IACjC,CAAA,MAAA,IAAW,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,EAAG;AAChC,MAAA,GAAA,CAAI,OAAA,GAAA,CAAW,GAAA,CAAI,OAAA,GAAU,GAAA,CAAI,OAAA,GAAU,GAAA,GAAM,EAAA,IAAM,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAAA,IAC5E,CAAA,MAAA,IAAW,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,EAAG;AACjC,MAAA,OAAA,GAAU,EAAE,KAAA,EAAO,IAAA,CAAK,KAAA,CAAM,CAAC,EAAE,IAAA,EAAK,EAAG,KAAA,EAAO,EAAC,EAAE;AACnD,MAAA,GAAA,CAAI,QAAA,CAAS,KAAK,OAAO,CAAA;AAAA,IAC3B,CAAA,MAAA,IAAW,OAAA,IAAW,MAAA,CAAO,IAAA,CAAK,IAAI,CAAA,EAAG;AACvC,MAAA,MAAM,CAAA,GAAI,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA;AAC3B,MAAA,OAAA,CAAQ,MAAM,IAAA,CAAK,EAAE,OAAO,CAAA,CAAE,CAAC,GAAI,GAAA,EAAK,CAAA,CAAE,CAAC,CAAA,EAAI,OAAO,CAAA,CAAE,CAAC,GAAG,IAAA,EAAK,IAAK,QAAW,CAAA;AAAA,IACnF,CAAA,MAAA,IAAW,CAAC,OAAA,IAAW,IAAA,IAAQ,CAAC,IAAA,CAAK,UAAA,CAAW,GAAG,CAAA,EAAG;AACpD,MAAA,SAAA,CAAU,KAAK,IAAI,CAAA;AAAA,IACrB;AAAA,EACF;AACA,EAAA,MAAM,OAAA,GAAU,SAAA,CAAU,IAAA,CAAK,IAAI,EAAE,IAAA,EAAK;AAC1C,EAAA,IAAI,OAAA,MAAa,OAAA,GAAU,OAAA;AAC3B,EAAA,OAAO,GAAA;AACT","file":"index.cjs","sourcesContent":["/**\n * @lacspace/llms-txt\n * Generate and parse llms.txt and llms-full.txt (the llmstxt.org standard).\n *\n * llms.txt is a Markdown file at your site root that gives LLMs a curated map of\n * your most useful content; llms-full.txt inlines the full text so a model can\n * read everything in one request.\n *\n * Zero dependencies · isomorphic · fully typed.\n */\n\nexport interface LlmsLink {\n  title: string;\n  url: string;\n  /** Short note shown after the link. */\n  notes?: string;\n}\n\nexport interface LlmsSection {\n  title: string;\n  links: LlmsLink[];\n}\n\nexport interface LlmsDoc {\n  /** The site / project name (rendered as the H1). */\n  title: string;\n  /** One-line summary (rendered as a blockquote). */\n  summary?: string;\n  /** Free-form Markdown shown before the sections. */\n  details?: string;\n  sections: LlmsSection[];\n}\n\n/**\n * Render an `llms.txt` document.\n * @example\n * llmsTxt({\n *   title: \"Lacspace\",\n *   summary: \"Open-source TypeScript packages and products.\",\n *   sections: [{ title: \"Docs\", links: [{ title: \"Packages\", url: \"https://lacspace.com/packages\" }] }],\n * });\n */\nexport function llmsTxt(doc: LlmsDoc): string {\n  const out: string[] = [`# ${doc.title}`];\n  if (doc.summary) out.push(\"\", `> ${doc.summary}`);\n  if (doc.details) out.push(\"\", doc.details.trim());\n  for (const section of doc.sections) {\n    out.push(\"\", `## ${section.title}`, \"\");\n    for (const l of section.links) {\n      out.push(`- [${l.title}](${l.url})${l.notes ? `: ${l.notes}` : \"\"}`);\n    }\n  }\n  return out.join(\"\\n\") + \"\\n\";\n}\n\nexport interface LlmsFullSection {\n  title: string;\n  /** Full Markdown content for this section. */\n  content: string;\n  /** Optional source URL, added as a heading link. */\n  url?: string;\n}\n\nexport interface LlmsFullDoc {\n  title: string;\n  summary?: string;\n  sections: LlmsFullSection[];\n}\n\n/** Render an `llms-full.txt` document with the full content inlined. */\nexport function llmsFullTxt(doc: LlmsFullDoc): string {\n  const out: string[] = [`# ${doc.title}`];\n  if (doc.summary) out.push(\"\", `> ${doc.summary}`);\n  for (const section of doc.sections) {\n    out.push(\"\", \"---\", \"\", `## ${section.title}`);\n    if (section.url) out.push(\"\", `Source: ${section.url}`);\n    out.push(\"\", section.content.trim());\n  }\n  return out.join(\"\\n\") + \"\\n\";\n}\n\n/** Parse an `llms.txt` string back into a structured document. */\nexport function parseLlmsTxt(txt: string): LlmsDoc {\n  const lines = txt.split(/\\r?\\n/);\n  const doc: LlmsDoc = { title: \"\", sections: [] };\n  let current: LlmsSection | null = null;\n  const detailBuf: string[] = [];\n  const linkRe = /^-\\s*\\[([^\\]]+)\\]\\(([^)]+)\\)\\s*(?::\\s*(.*))?$/;\n\n  for (const raw of lines) {\n    const line = raw.trimEnd();\n    if (line.startsWith(\"# \")) {\n      doc.title = line.slice(2).trim();\n    } else if (line.startsWith(\"> \")) {\n      doc.summary = (doc.summary ? doc.summary + \" \" : \"\") + line.slice(2).trim();\n    } else if (line.startsWith(\"## \")) {\n      current = { title: line.slice(3).trim(), links: [] };\n      doc.sections.push(current);\n    } else if (current && linkRe.test(line)) {\n      const m = line.match(linkRe)!;\n      current.links.push({ title: m[1]!, url: m[2]!, notes: m[3]?.trim() || undefined });\n    } else if (!current && line && !line.startsWith(\"#\")) {\n      detailBuf.push(line);\n    }\n  }\n  const details = detailBuf.join(\"\\n\").trim();\n  if (details) doc.details = details;\n  return doc;\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,57 @@
+/**
+ * @lacspace/llms-txt
+ * Generate and parse llms.txt and llms-full.txt (the llmstxt.org standard).
+ *
+ * llms.txt is a Markdown file at your site root that gives LLMs a curated map of
+ * your most useful content; llms-full.txt inlines the full text so a model can
+ * read everything in one request.
+ *
+ * Zero dependencies · isomorphic · fully typed.
+ */
+interface LlmsLink {
+    title: string;
+    url: string;
+    /** Short note shown after the link. */
+    notes?: string;
+}
+interface LlmsSection {
+    title: string;
+    links: LlmsLink[];
+}
+interface LlmsDoc {
+    /** The site / project name (rendered as the H1). */
+    title: string;
+    /** One-line summary (rendered as a blockquote). */
+    summary?: string;
+    /** Free-form Markdown shown before the sections. */
+    details?: string;
+    sections: LlmsSection[];
+}
+/**
+ * Render an `llms.txt` document.
+ * @example
+ * llmsTxt({
+ *   title: "Lacspace",
+ *   summary: "Open-source TypeScript packages and products.",
+ *   sections: [{ title: "Docs", links: [{ title: "Packages", url: "https://lacspace.com/packages" }] }],
+ * });
+ */
+declare function llmsTxt(doc: LlmsDoc): string;
+interface LlmsFullSection {
+    title: string;
+    /** Full Markdown content for this section. */
+    content: string;
+    /** Optional source URL, added as a heading link. */
+    url?: string;
+}
+interface LlmsFullDoc {
+    title: string;
+    summary?: string;
+    sections: LlmsFullSection[];
+}
+/** Render an `llms-full.txt` document with the full content inlined. */
+declare function llmsFullTxt(doc: LlmsFullDoc): string;
+/** Parse an `llms.txt` string back into a structured document. */
+declare function parseLlmsTxt(txt: string): LlmsDoc;
+
+export { type LlmsDoc, type LlmsFullDoc, type LlmsFullSection, type LlmsLink, type LlmsSection, llmsFullTxt, llmsTxt, parseLlmsTxt };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @lacspace/llms-txt
+ * Generate and parse llms.txt and llms-full.txt (the llmstxt.org standard).
+ *
+ * llms.txt is a Markdown file at your site root that gives LLMs a curated map of
+ * your most useful content; llms-full.txt inlines the full text so a model can
+ * read everything in one request.
+ *
+ * Zero dependencies · isomorphic · fully typed.
+ */
+interface LlmsLink {
+    title: string;
+    url: string;
+    /** Short note shown after the link. */
+    notes?: string;
+}
+interface LlmsSection {
+    title: string;
+    links: LlmsLink[];
+}
+interface LlmsDoc {
+    /** The site / project name (rendered as the H1). */
+    title: string;
+    /** One-line summary (rendered as a blockquote). */
+    summary?: string;
+    /** Free-form Markdown shown before the sections. */
+    details?: string;
+    sections: LlmsSection[];
+}
+/**
+ * Render an `llms.txt` document.
+ * @example
+ * llmsTxt({
+ *   title: "Lacspace",
+ *   summary: "Open-source TypeScript packages and products.",
+ *   sections: [{ title: "Docs", links: [{ title: "Packages", url: "https://lacspace.com/packages" }] }],
+ * });
+ */
+declare function llmsTxt(doc: LlmsDoc): string;
+interface LlmsFullSection {
+    title: string;
+    /** Full Markdown content for this section. */
+    content: string;
+    /** Optional source URL, added as a heading link. */
+    url?: string;
+}
+interface LlmsFullDoc {
+    title: string;
+    summary?: string;
+    sections: LlmsFullSection[];
+}
+/** Render an `llms-full.txt` document with the full content inlined. */
+declare function llmsFullTxt(doc: LlmsFullDoc): string;
+/** Parse an `llms.txt` string back into a structured document. */
+declare function parseLlmsTxt(txt: string): LlmsDoc;
+
+export { type LlmsDoc, type LlmsFullDoc, type LlmsFullSection, type LlmsLink, type LlmsSection, llmsFullTxt, llmsTxt, parseLlmsTxt };

package/dist/index.js

@@ -0,0 +1,53 @@
+// src/index.ts
+function llmsTxt(doc) {
+  const out = [`# ${doc.title}`];
+  if (doc.summary) out.push("", `> ${doc.summary}`);
+  if (doc.details) out.push("", doc.details.trim());
+  for (const section of doc.sections) {
+    out.push("", `## ${section.title}`, "");
+    for (const l of section.links) {
+      out.push(`- [${l.title}](${l.url})${l.notes ? `: ${l.notes}` : ""}`);
+    }
+  }
+  return out.join("\n") + "\n";
+}
+function llmsFullTxt(doc) {
+  const out = [`# ${doc.title}`];
+  if (doc.summary) out.push("", `> ${doc.summary}`);
+  for (const section of doc.sections) {
+    out.push("", "---", "", `## ${section.title}`);
+    if (section.url) out.push("", `Source: ${section.url}`);
+    out.push("", section.content.trim());
+  }
+  return out.join("\n") + "\n";
+}
+function parseLlmsTxt(txt) {
+  const lines = txt.split(/\r?\n/);
+  const doc = { title: "", sections: [] };
+  let current = null;
+  const detailBuf = [];
+  const linkRe = /^-\s*\[([^\]]+)\]\(([^)]+)\)\s*(?::\s*(.*))?$/;
+  for (const raw of lines) {
+    const line = raw.trimEnd();
+    if (line.startsWith("# ")) {
+      doc.title = line.slice(2).trim();
+    } else if (line.startsWith("> ")) {
+      doc.summary = (doc.summary ? doc.summary + " " : "") + line.slice(2).trim();
+    } else if (line.startsWith("## ")) {
+      current = { title: line.slice(3).trim(), links: [] };
+      doc.sections.push(current);
+    } else if (current && linkRe.test(line)) {
+      const m = line.match(linkRe);
+      current.links.push({ title: m[1], url: m[2], notes: m[3]?.trim() || void 0 });
+    } else if (!current && line && !line.startsWith("#")) {
+      detailBuf.push(line);
+    }
+  }
+  const details = detailBuf.join("\n").trim();
+  if (details) doc.details = details;
+  return doc;
+}
+
+export { llmsFullTxt, llmsTxt, parseLlmsTxt };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AA0CO,SAAS,QAAQ,GAAA,EAAsB;AAC5C,EAAA,MAAM,GAAA,GAAgB,CAAC,CAAA,EAAA,EAAK,GAAA,CAAI,KAAK,CAAA,CAAE,CAAA;AACvC,EAAA,IAAI,GAAA,CAAI,SAAS,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,EAAA,EAAK,GAAA,CAAI,OAAO,CAAA,CAAE,CAAA;AAChD,EAAA,IAAI,GAAA,CAAI,SAAS,GAAA,CAAI,IAAA,CAAK,IAAI,GAAA,CAAI,OAAA,CAAQ,MAAM,CAAA;AAChD,EAAA,KAAA,MAAW,OAAA,IAAW,IAAI,QAAA,EAAU;AAClC,IAAA,GAAA,CAAI,KAAK,EAAA,EAAI,CAAA,GAAA,EAAM,OAAA,CAAQ,KAAK,IAAI,EAAE,CAAA;AACtC,IAAA,KAAA,MAAW,CAAA,IAAK,QAAQ,KAAA,EAAO;AAC7B,MAAA,GAAA,CAAI,IAAA,CAAK,CAAA,GAAA,EAAM,CAAA,CAAE,KAAK,KAAK,CAAA,CAAE,GAAG,CAAA,CAAA,EAAI,CAAA,CAAE,QAAQ,CAAA,EAAA,EAAK,CAAA,CAAE,KAAK,CAAA,CAAA,GAAK,EAAE,CAAA,CAAE,CAAA;AAAA,IACrE;AAAA,EACF;AACA,EAAA,OAAO,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,GAAI,IAAA;AAC1B;AAiBO,SAAS,YAAY,GAAA,EAA0B;AACpD,EAAA,MAAM,GAAA,GAAgB,CAAC,CAAA,EAAA,EAAK,GAAA,CAAI,KAAK,CAAA,CAAE,CAAA;AACvC,EAAA,IAAI,GAAA,CAAI,SAAS,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,EAAA,EAAK,GAAA,CAAI,OAAO,CAAA,CAAE,CAAA;AAChD,EAAA,KAAA,MAAW,OAAA,IAAW,IAAI,QAAA,EAAU;AAClC,IAAA,GAAA,CAAI,KAAK,EAAA,EAAI,KAAA,EAAO,IAAI,CAAA,GAAA,EAAM,OAAA,CAAQ,KAAK,CAAA,CAAE,CAAA;AAC7C,IAAA,IAAI,OAAA,CAAQ,KAAK,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,QAAA,EAAW,OAAA,CAAQ,GAAG,CAAA,CAAE,CAAA;AACtD,IAAA,GAAA,CAAI,IAAA,CAAK,EAAA,EAAI,OAAA,CAAQ,OAAA,CAAQ,MAAM,CAAA;AAAA,EACrC;AACA,EAAA,OAAO,GAAA,CAAI,IAAA,CAAK,IAAI,CAAA,GAAI,IAAA;AAC1B;AAGO,SAAS,aAAa,GAAA,EAAsB;AACjD,EAAA,MAAM,KAAA,GAAQ,GAAA,CAAI,KAAA,CAAM,OAAO,CAAA;AAC/B,EAAA,MAAM,MAAe,EAAE,KAAA,EAAO,EAAA,EAAI,QAAA,EAAU,EAAC,EAAE;AAC/C,EAAA,IAAI,OAAA,GAA8B,IAAA;AAClC,EAAA,MAAM,YAAsB,EAAC;AAC7B,EAAA,MAAM,MAAA,GAAS,+CAAA;AAEf,EAAA,KAAA,MAAW,OAAO,KAAA,EAAO;AACvB,IAAA,MAAM,IAAA,GAAO,IAAI,OAAA,EAAQ;AACzB,IAAA,IAAI,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,EAAG;AACzB,MAAA,GAAA,CAAI,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,CAAC,EAAE,IAAA,EAAK;AAAA,IACjC,CAAA,MAAA,IAAW,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA,EAAG;AAChC,MAAA,GAAA,CAAI,OAAA,GAAA,CAAW,GAAA,CAAI,OAAA,GAAU,GAAA,CAAI,OAAA,GAAU,GAAA,GAAM,EAAA,IAAM,IAAA,CAAK,KAAA,CAAM,CAAC,CAAA,CAAE,IAAA,EAAK;AAAA,IAC5E,CAAA,MAAA,IAAW,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,EAAG;AACjC,MAAA,OAAA,GAAU,EAAE,KAAA,EAAO,IAAA,CAAK,KAAA,CAAM,CAAC,EAAE,IAAA,EAAK,EAAG,KAAA,EAAO,EAAC,EAAE;AACnD,MAAA,GAAA,CAAI,QAAA,CAAS,KAAK,OAAO,CAAA;AAAA,IAC3B,CAAA,MAAA,IAAW,OAAA,IAAW,MAAA,CAAO,IAAA,CAAK,IAAI,CAAA,EAAG;AACvC,MAAA,MAAM,CAAA,GAAI,IAAA,CAAK,KAAA,CAAM,MAAM,CAAA;AAC3B,MAAA,OAAA,CAAQ,MAAM,IAAA,CAAK,EAAE,OAAO,CAAA,CAAE,CAAC,GAAI,GAAA,EAAK,CAAA,CAAE,CAAC,CAAA,EAAI,OAAO,CAAA,CAAE,CAAC,GAAG,IAAA,EAAK,IAAK,QAAW,CAAA;AAAA,IACnF,CAAA,MAAA,IAAW,CAAC,OAAA,IAAW,IAAA,IAAQ,CAAC,IAAA,CAAK,UAAA,CAAW,GAAG,CAAA,EAAG;AACpD,MAAA,SAAA,CAAU,KAAK,IAAI,CAAA;AAAA,IACrB;AAAA,EACF;AACA,EAAA,MAAM,OAAA,GAAU,SAAA,CAAU,IAAA,CAAK,IAAI,EAAE,IAAA,EAAK;AAC1C,EAAA,IAAI,OAAA,MAAa,OAAA,GAAU,OAAA;AAC3B,EAAA,OAAO,GAAA;AACT","file":"index.js","sourcesContent":["/**\n * @lacspace/llms-txt\n * Generate and parse llms.txt and llms-full.txt (the llmstxt.org standard).\n *\n * llms.txt is a Markdown file at your site root that gives LLMs a curated map of\n * your most useful content; llms-full.txt inlines the full text so a model can\n * read everything in one request.\n *\n * Zero dependencies · isomorphic · fully typed.\n */\n\nexport interface LlmsLink {\n  title: string;\n  url: string;\n  /** Short note shown after the link. */\n  notes?: string;\n}\n\nexport interface LlmsSection {\n  title: string;\n  links: LlmsLink[];\n}\n\nexport interface LlmsDoc {\n  /** The site / project name (rendered as the H1). */\n  title: string;\n  /** One-line summary (rendered as a blockquote). */\n  summary?: string;\n  /** Free-form Markdown shown before the sections. */\n  details?: string;\n  sections: LlmsSection[];\n}\n\n/**\n * Render an `llms.txt` document.\n * @example\n * llmsTxt({\n *   title: \"Lacspace\",\n *   summary: \"Open-source TypeScript packages and products.\",\n *   sections: [{ title: \"Docs\", links: [{ title: \"Packages\", url: \"https://lacspace.com/packages\" }] }],\n * });\n */\nexport function llmsTxt(doc: LlmsDoc): string {\n  const out: string[] = [`# ${doc.title}`];\n  if (doc.summary) out.push(\"\", `> ${doc.summary}`);\n  if (doc.details) out.push(\"\", doc.details.trim());\n  for (const section of doc.sections) {\n    out.push(\"\", `## ${section.title}`, \"\");\n    for (const l of section.links) {\n      out.push(`- [${l.title}](${l.url})${l.notes ? `: ${l.notes}` : \"\"}`);\n    }\n  }\n  return out.join(\"\\n\") + \"\\n\";\n}\n\nexport interface LlmsFullSection {\n  title: string;\n  /** Full Markdown content for this section. */\n  content: string;\n  /** Optional source URL, added as a heading link. */\n  url?: string;\n}\n\nexport interface LlmsFullDoc {\n  title: string;\n  summary?: string;\n  sections: LlmsFullSection[];\n}\n\n/** Render an `llms-full.txt` document with the full content inlined. */\nexport function llmsFullTxt(doc: LlmsFullDoc): string {\n  const out: string[] = [`# ${doc.title}`];\n  if (doc.summary) out.push(\"\", `> ${doc.summary}`);\n  for (const section of doc.sections) {\n    out.push(\"\", \"---\", \"\", `## ${section.title}`);\n    if (section.url) out.push(\"\", `Source: ${section.url}`);\n    out.push(\"\", section.content.trim());\n  }\n  return out.join(\"\\n\") + \"\\n\";\n}\n\n/** Parse an `llms.txt` string back into a structured document. */\nexport function parseLlmsTxt(txt: string): LlmsDoc {\n  const lines = txt.split(/\\r?\\n/);\n  const doc: LlmsDoc = { title: \"\", sections: [] };\n  let current: LlmsSection | null = null;\n  const detailBuf: string[] = [];\n  const linkRe = /^-\\s*\\[([^\\]]+)\\]\\(([^)]+)\\)\\s*(?::\\s*(.*))?$/;\n\n  for (const raw of lines) {\n    const line = raw.trimEnd();\n    if (line.startsWith(\"# \")) {\n      doc.title = line.slice(2).trim();\n    } else if (line.startsWith(\"> \")) {\n      doc.summary = (doc.summary ? doc.summary + \" \" : \"\") + line.slice(2).trim();\n    } else if (line.startsWith(\"## \")) {\n      current = { title: line.slice(3).trim(), links: [] };\n      doc.sections.push(current);\n    } else if (current && linkRe.test(line)) {\n      const m = line.match(linkRe)!;\n      current.links.push({ title: m[1]!, url: m[2]!, notes: m[3]?.trim() || undefined });\n    } else if (!current && line && !line.startsWith(\"#\")) {\n      detailBuf.push(line);\n    }\n  }\n  const details = detailBuf.join(\"\\n\").trim();\n  if (details) doc.details = details;\n  return doc;\n}\n"]}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@lacspace/llms-txt",
+  "version": "1.0.0",
+  "description": "Generate and parse llms.txt and llms-full.txt (the llmstxt.org standard) — a Markdown map of your site for LLMs. Zero-dependency, isomorphic.",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": { "types": "./dist/index.d.cts", "default": "./dist/index.cjs" }
+    }
+  },
+  "files": ["dist"],
+  "sideEffects": false,
+  "scripts": { "build": "tsup", "prepublishOnly": "npm run build" },
+  "keywords": ["llms-txt", "llms-full-txt", "llmstxt", "ai-seo", "llm", "generative-engine-optimization", "geo", "seo", "typescript"],
+  "author": "Lacspace <contact@lacspace.com>",
+  "license": "MIT",
+  "homepage": "https://lacspace.com/packages",
+  "repository": { "type": "git", "url": "git+https://github.com/lacspace/npm-packages.git", "directory": "llms-txt" },
+  "bugs": { "url": "https://github.com/lacspace/npm-packages/issues" },
+  "engines": { "node": ">=18" }
+}