nuxt-llms 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Nuxt Project
+
+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,111 @@
+# Nuxt LLMs
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+Nuxt LLMs automatically generates [`llms.txt` markdown documentation](https://llmstxt.org/) for your Nuxt application.  It provides runtime hooks to collect data from various sources (CMS, Nuxt Content, etc.) and generate structured documentation in a text-based format.
+
+- [✨  Release Notes](/CHANGELOG.md)
+<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nuxt-llms?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+- Generates & prerenders `/llms.txt` and `/llms_full.txt` routes automatically
+- Customizable sections directly from your `nuxt.config.ts`
+- Integrates with Nuxt modules and your application via the runtime hooks system
+
+## Quick Setup
+
+1. Install the module:
+
+```bash
+npm i nuxt-llms
+```
+
+2. Register `nuxt-llms` in your `nuxt.config.ts`:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['nuxt-llms']
+})
+```
+
+3. Configure your application details:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['nuxt-llms'],
+  llms: {
+    domain: 'https://example.com',
+    title: 'My Application',
+    description: 'My Application Description',
+    sections: [
+      {
+        title: 'Section 1',
+        description: 'Section 1 Description',
+        links: [
+          {
+            title: 'Link 1',
+            description: 'Link 1 Description',
+            href: '/link-1',
+          },
+          {
+            title: 'Link 2',
+            description: 'Link 2 Description',
+            href: '/link-2',
+          },
+        ],
+      },
+    ],
+  },
+})
+```
+
+That's it! You can visit `/llms.txt` to see the generated documentation ✨
+
+## Options
+
+- `domain`(required): The domain of the application
+- `title`: The title of the application, will be displayed at the top of the documentation
+- `description`: The description of the application, will be displayed at the top of the documentation right after the title
+- `sections`: The sections of the documentation.
+  Section are consisted of a title, one or more paragraphs of description and possibly a list of links.
+  Each section is an object with the following properties:
+  - `title`(required): The title of the section
+  - `description`: The description of the section
+  - `links`: The links of the section
+    - `title`(required): The title of the link
+    - `description`: The description of the link
+    - `href`(required): The href of the link
+- `notes`: The notes of the documentation. Notes are a special section which always appears at the end of the documentation. Notes are usefull to add any information about the application or documentation itself.
+
+## 💻 Development
+
+- Clone repository
+- Install dependencies using `pnpm install`
+- Prepare using `pnpm dev:prepare`
+- Build using `pnpm prepack`
+- Try playground using `pnpm dev`
+- Test using `pnpm test`
+
+## License
+
+[MIT License](LICENSE)
+
+Copyright (c) NuxtLabs
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/nuxt-llms/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/nuxt-llms
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-llms.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npm.chart.dev/nuxt-llms
+
+[license-src]: https://img.shields.io/npm/l/nuxt-llms.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/nuxt-llms
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,32 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface LLMsSection {
+    title: string;
+    description?: string;
+    links?: Array<{
+        title: string;
+        description?: string;
+        href: string;
+    }>;
+}
+interface ModuleOptions {
+    /**
+     * Domain of the documentation
+     */
+    domain: string;
+    /**
+     * Enable the full documentation
+     */
+    llmsFull?: {
+        title: string;
+        description: string;
+    };
+    sections: Array<LLMsSection>;
+    title?: string;
+    description?: string;
+    notes?: string[];
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { type LLMsSection, type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -0,0 +1,32 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface LLMsSection {
+    title: string;
+    description?: string;
+    links?: Array<{
+        title: string;
+        description?: string;
+        href: string;
+    }>;
+}
+interface ModuleOptions {
+    /**
+     * Domain of the documentation
+     */
+    domain: string;
+    /**
+     * Enable the full documentation
+     */
+    llmsFull?: {
+        title: string;
+        description: string;
+    };
+    sections: Array<LLMsSection>;
+    title?: string;
+    description?: string;
+    notes?: string[];
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { type LLMsSection, type ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "Nuxt LLMS",
+  "configKey": "llms",
+  "version": "0.0.1",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "2.0.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,43 @@
+import { defineNuxtModule, useLogger, createResolver, addServerImports, addServerHandler, addPrerenderRoutes } from '@nuxt/kit';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "Nuxt LLMS",
+    configKey: "llms"
+  },
+  defaults: {},
+  setup(options, nuxt) {
+    const logger = useLogger("nuxt-llms");
+    const { resolve } = createResolver(import.meta.url);
+    const llmsConfig = nuxt.options.runtimeConfig.llms = {
+      domain: options.domain,
+      title: options.title,
+      description: options.description,
+      notes: options.notes || [],
+      sections: options.sections || []
+    };
+    if (!options.domain) {
+      logger.warn("nuxt-llms require a domain to be set. `llms.domain` is missing.");
+      return;
+    }
+    addServerImports([{ name: "llmsHooks", from: resolve("./runtime/server/utils/hooks") }]);
+    addServerHandler({ route: "/llms.txt", handler: resolve("./runtime/server/routes/llms.txt.get") });
+    addPrerenderRoutes("/llms.txt");
+    if (options.llmsFull) {
+      llmsConfig.sections.unshift({
+        title: "Documentation Sets",
+        links: [
+          {
+            title: options.llmsFull.title,
+            description: options.llmsFull.description,
+            href: `${options.domain}/llms_full.txt`
+          }
+        ]
+      });
+      addServerHandler({ route: "/llms_full.txt", handler: resolve("./runtime/server/routes/llms_full.txt.get") });
+      addPrerenderRoutes("/llms_full.txt");
+    }
+  }
+});
+
+export { module as default };

package/dist/runtime/index.d.ts

@@ -0,0 +1 @@
+export * from './server/utils/hooks.js';

package/dist/runtime/index.js

@@ -0,0 +1 @@
+export * from "./server/utils/hooks.js";

package/dist/runtime/server/routes/llms.txt.get.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+export default _default;

package/dist/runtime/server/routes/llms.txt.get.js

@@ -0,0 +1,33 @@
+import { eventHandler, setHeader } from "h3";
+import { llmsHooks } from "nuxt-llms/runtime";
+import { useRuntimeConfig } from "#imports";
+export default eventHandler(async (event) => {
+  const options = useRuntimeConfig(event).llms;
+  const llms = JSON.parse(JSON.stringify(options));
+  await llmsHooks.callHook("generate", event, llms);
+  const document = [
+    `# ${llms.title || "Documentation"}`
+  ];
+  if (llms.description) {
+    document.push(`> ${options.description}`);
+  }
+  for (const section of llms.sections) {
+    document.push(`## ${section.title}`);
+    if (section.description) {
+      document.push(section.description);
+    }
+    document.push(
+      section.links?.map((link) => {
+        return `- [${link.title}](${link.href}): ${link.description}`;
+      }).join("\n") || ""
+    );
+  }
+  if (options.notes && options.notes.length) {
+    document.push(
+      "## Notes",
+      (options.notes || []).map((note) => `- ${note}`).join("\n")
+    );
+  }
+  setHeader(event, "Content-Type", "text/plain");
+  return document.join("\n\n");
+});

package/dist/runtime/server/routes/llms_full.txt.get.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+export default _default;

package/dist/runtime/server/routes/llms_full.txt.get.js

@@ -0,0 +1,20 @@
+import { eventHandler, setHeader } from "h3";
+import { llmsHooks } from "nuxt-llms/runtime";
+import { useRuntimeConfig } from "#imports";
+export default eventHandler(async (event) => {
+  const options = useRuntimeConfig(event).llms;
+  const contents = [];
+  const llms = JSON.parse(JSON.stringify(options));
+  await llmsHooks.callHook("generate:full", event, llms, contents);
+  const document = [
+    `# ${llms.llmsFull?.title || "Documentation"}`
+  ];
+  if (llms.description) {
+    document.push(`> ${llms.llmsFull?.description}`);
+  }
+  for (const content of contents) {
+    document.push(content);
+  }
+  setHeader(event, "Content-Type", "text/plain");
+  return contents.join("\n\n");
+});

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

package/dist/runtime/server/utils/hooks.d.ts

@@ -0,0 +1,15 @@
+import type { H3Event } from 'h3';
+import type { ModuleOptions } from 'nuxt-llms';
+export interface LLMSHooks {
+    'generate': (event: H3Event, options: ModuleOptions) => void;
+    'generate:full': (event: H3Event, options: ModuleOptions, contents: string[]) => void;
+}
+export declare const llmsHooks: import("hookable").Hookable<LLMSHooks, import("hookable").HookKeys<LLMSHooks>>;
+/**
+ * Run a callback when LLMs is being generated.
+ */
+export declare function onLLMsGenerate(cb: LLMSHooks['generate']): () => void;
+/**
+ * Run a callback when Full LLMs is being generated.
+ */
+export declare function onLLMsGenerateFull(cb: LLMSHooks['generate:full']): () => void;

package/dist/runtime/server/utils/hooks.js

@@ -0,0 +1,8 @@
+import { createHooks } from "hookable";
+export const llmsHooks = createHooks();
+export function onLLMsGenerate(cb) {
+  return llmsHooks.hook("generate", cb);
+}
+export function onLLMsGenerateFull(cb) {
+  return llmsHooks.hook("generate:full", cb);
+}

package/dist/types.d.mts

@@ -0,0 +1 @@
+export { type LLMsSection, type ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1 @@
+export { type LLMsSection, type ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "nuxt-llms",
+  "version": "0.0.1",
+  "description": "Generate llms.txt documentation for your Nuxt application",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuxtlabs/nuxt-llms.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    },
+    "./runtime": {
+      "types": "./dist/runtime/index.d.ts",
+      "import": "./dist/runtime/index.js",
+      "require": "./dist/runtime/index.js"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "typecheck": "nuxi typecheck",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
+    "verify": "npm run dev:prepare && npm run lint && npm run test && npm run typecheck"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.15.4"
+  },
+  "devDependencies": {
+    "nuxt-llms": "link:.",
+    "@nuxt/devtools": "^2.1.0",
+    "@nuxt/eslint-config": "^1.1.0",
+    "@nuxt/module-builder": "^0.8.4",
+    "@nuxt/schema": "^3.15.4",
+    "@nuxt/test-utils": "^3.15.4",
+    "@types/node": "latest",
+    "changelogen": "^0.5.7",
+    "eslint": "^9.20.1",
+    "nuxt": "^3.15.4",
+    "typescript": "~5.6.0",
+    "vitest": "^3.0.6",
+    "vue-tsc": "^2.2.2"
+  },
+  "packageManager": "pnpm@10.4.1"
+}