nuxt-llms 0.0.1 → 0.0.2

package/README.md

@@ -13,7 +13,8 @@ Nuxt LLMs automatically generates [`llms.txt` markdown documentation](https://ll
 
 ## Features
 
-- Generates & prerenders `/llms.txt` and `/llms_full.txt` routes automatically
+- Generates & prerenders `/llms.txt` automatically
+- Generate & prerenders `/llms_full.txt` when enabled
 - Customizable sections directly from your `nuxt.config.ts`
 - Integrates with Nuxt modules and your application via the runtime hooks system
 
@@ -81,6 +82,144 @@ That's it! You can visit `/llms.txt` to see the generated documentation ✨
     - `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.
+- `full`: The `llms_full.txt` configuration. Setting this option will enable the `llms_full.txt` route.
+  - `title`: The title of the llms_full documentation
+  - `description`: The description of the llms_full documentation
+
+## Documentation Formats
+
+The module generates two different documentation formats:
+
+### llms.txt
+
+The `/llms.txt` route generates a concise, structured documentation that follows the [llms.txt specification](https://llmstxt.org/). This format is optimized for both human readability and AI consumption. It includes:
+
+- Application title and description
+- Organized sections with titles and descriptions
+- Links with titles, descriptions, and URLs
+- Optional notes section
+
+### llms_full.txt
+
+The `/llms_full.txt` route provides a more detailed, free-form documentation format. This is useful to reduce crawler traffic on your application and provide a more detailed documentation to your users and LLMs.
+
+By default module does not generate the `llms_full.txt` route, you need to enable it by setting `full.title` and `full.description` in your `nuxt.config.ts`.
+
+```ts
+export default defineNuxtConfig({
+  llms: {
+    domain: 'https://example.com',
+    title: 'My Application',
+    full: {
+      title: 'Full Documentation',
+      description: 'Full documentation of the application',
+    },
+  },
+})
+```
+
+## Extending the documentation using hooks
+
+The module provides a hooks system that allows you to dynamically extend both documentation formats. There are two main hooks:
+
+### Available Hooks
+
+#### `generate:llms(event, options)`
+
+This hook is called for every request to `/llms.txt`. Use this hook to modify the structured documentation, It allows you to add sections, links, and metadata.
+
+**Parameters:**
+  - `event`: H3Event - The current request event
+  - `options`: ModuleOptions - The module options that you can modify to add sections, links, etc.
+
+
+#### `generate:llms_full(event, options, contents)`
+
+This hook is called for every request to `/llms_full.txt`. It allows you to add custom content sections in any format.
+
+**Parameters:**
+  - `event`: H3Event - The current request event
+  - `options`: ModuleOptions - The module options that you can modify to add sections, links, etc.
+  - `contents`: string[] - Array of content sections you can add to or modify
+
+### Using Hooks in Your Application
+
+Create a server plugin in your `server/plugins` directory:
+
+```ts
+// server/plugins/llms.ts
+import { onLLMsGenerate, onLLMsGenerateFull, llmsHooks } from 'nuxt-llms/runtime'
+
+export default defineNitroPlugin(() => {
+  // Method 1: Using the hooks directly
+  llmsHooks.hook('generate', (event, options) => {
+    // Add a new section to llms.txt
+    options.sections.push({
+      title: 'API Documentation',
+      description: 'REST API endpoints and usage',
+      links: [
+        {
+          title: 'Authentication',
+          description: 'API authentication methods',
+          href: `${options.domain}/api/auth`
+        }
+      ]
+    })
+  })
+
+  // Method 2: Using the helper function
+  onLLMsGenerateFull((event, options, contents) => {
+    // Add detailed documentation to llms_full.txt
+    contents.push(`## API Authentication
+
+### Bearer Token
+To authenticate API requests, include a Bearer token in the Authorization header:
+
+\`\`\`
+Authorization: Bearer <your-token>
+\`\`\`
+
+### API Keys
+For server-to-server communication, use API keys:
+
+\`\`\`
+X-API-Key: <your-api-key>
+\`\`\`
+    `)
+  })
+})
+```
+
+### Using Hooks in Nuxt Modules
+
+If you're developing a Nuxt module that needs to extend the LLMs documentation:
+
+1. Create a server plugin in your module:
+```ts
+// module/runtime/server/plugins/my-module-llms.ts
+export default defineNitroPlugin(() => {
+  onLLMsGenerate((event, options) => {
+    options.sections.push({
+      title: 'My Module',
+      description: 'Documentation for my module features',
+      links: [/* ... */]
+    })
+  })
+})
+```
+
+2. Register the plugin in your module setup:
+```ts
+import { defineNuxtModule, addServerPlugin } from '@nuxt/kit'
+import { fileURLToPath } from 'url'
+
+export default defineNuxtModule({
+  setup(options, nuxt) {
+    const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url))
+    addServerPlugin(resolve(runtimeDir, 'server/plugins/my-module-llms'))
+  }
+})
+```
 
 ## 💻 Development
 

package/dist/module.d.mts

@@ -17,7 +17,7 @@ interface ModuleOptions {
     /**
      * Enable the full documentation
      */
-    llmsFull?: {
+    full?: {
         title: string;
         description: string;
     };

package/dist/module.d.ts

@@ -17,7 +17,7 @@ interface ModuleOptions {
     /**
      * Enable the full documentation
      */
-    llmsFull?: {
+    full?: {
         title: string;
         description: string;
     };

package/dist/module.json

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

package/dist/module.mjs

@@ -23,13 +23,13 @@ const module = defineNuxtModule({
     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) {
+    if (options.full) {
       llmsConfig.sections.unshift({
         title: "Documentation Sets",
         links: [
           {
-            title: options.llmsFull.title,
-            description: options.llmsFull.description,
+            title: options.full.title,
+            description: options.full.description,
             href: `${options.domain}/llms_full.txt`
           }
         ]

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

@@ -7,10 +7,10 @@ export default eventHandler(async (event) => {
   const llms = JSON.parse(JSON.stringify(options));
   await llmsHooks.callHook("generate:full", event, llms, contents);
   const document = [
-    `# ${llms.llmsFull?.title || "Documentation"}`
+    `# ${llms.full?.title || "Documentation"}`
   ];
   if (llms.description) {
-    document.push(`> ${llms.llmsFull?.description}`);
+    document.push(`> ${llms.full?.description}`);
   }
   for (const content of contents) {
     document.push(content);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-llms",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Generate llms.txt documentation for your Nuxt application",
   "repository": {
     "type": "git",