nuxt-llms 0.1.0 → 0.1.2

package/README.md

@@ -16,7 +16,7 @@ Nuxt LLMs automatically generates [`llms.txt` markdown documentation](https://ll
 ## Features
 
 - Generates & prerenders `/llms.txt` automatically
-- Generate & prerenders `/llms_full.txt` when enabled
+- 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
 
@@ -84,9 +84,9 @@ 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 useful 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
+- `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
 
@@ -101,11 +101,11 @@ The `/llms.txt` route generates a concise, structured documentation that follows
 - Links with titles, descriptions, and URLs
 - Optional notes section
 
-### llms_full.txt
+### 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.
+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`.
+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({
@@ -135,9 +135,9 @@ This hook is called for every request to `/llms.txt`. Use this hook to modify th
   - `options`: ModuleOptions - The module options that you can modify to add sections, links, etc.
 
 
-#### `llms:generate:llms_full(event, options, contents)`
+#### `llms: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.
+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
@@ -169,7 +169,7 @@ export default defineNitroPlugin((nitroApp) => {
 
   // Method 2: Using the helper function
   nitroApp.hooks.hook('llms:generate:full', (event, options, contents) => {
-    // Add detailed documentation to llms_full.txt
+    // Add detailed documentation to llms-full.txt
     contents.push(`## API Authentication
 
 ### Bearer Token
@@ -225,7 +225,7 @@ export default defineNuxtModule({
 
 ### Nuxt Content
 
-Nuxt Content ^3.2.0 comes with built-in support for LLMs documentation. You can use `nuxt-llms` with `@nuxt/content` to efficiently write content and documentation for your website and generate LLM-friendly documentation without extra effort. Content module uses `nuxt-llms` hooks and automatically adds all your contents into `llms.txt` and `llms_full.txt` documentation.
+Nuxt Content ^3.2.0 comes with built-in support for LLMs documentation. You can use `nuxt-llms` with `@nuxt/content` to efficiently write content and documentation for your website and generate LLM-friendly documentation without extra effort. Content module uses `nuxt-llms` hooks and automatically adds all your contents into `llms.txt` and `llms-full.txt` documentation.
 
 All you need is to install both modules and write your content files in the `content` directory.
 

package/dist/module.json

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

package/dist/module.mjs

@@ -30,12 +30,12 @@ const module = defineNuxtModule({
           {
             title: options.full.title,
             description: options.full.description,
-            href: `${options.domain}/llms_full.txt`
+            href: `${options.domain}/llms-full.txt`
           }
         ]
       });
-      addServerHandler({ route: "/llms_full.txt", handler: resolve("./runtime/server/routes/llms_full.txt.get") });
-      addPrerenderRoutes("/llms_full.txt");
+      addServerHandler({ route: "/llms-full.txt", handler: resolve("./runtime/server/routes/llms-full.txt.get") });
+      addPrerenderRoutes("/llms-full.txt");
     }
   }
 });

package/dist/runtime/server/routes/{llms_full.txt.get.js → llms-full.txt.get.js}

@@ -7,6 +7,6 @@ export default eventHandler(async (event) => {
   const llms = JSON.parse(JSON.stringify(options));
   await useNitroApp().hooks.callHook("llms:generate:full", event, llms, contents);
   await llmsHooks.callHook("generate:full", event, llms, contents);
-  setHeader(event, "Content-Type", "text/plain");
+  setHeader(event, "Content-Type", "text/plain; charset=utf-8");
   return contents.join("\n\n");
 });

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

@@ -19,7 +19,7 @@ export default eventHandler(async (event) => {
     }
     document.push(
       section.links?.map((link) => {
-        return `- [${link.title}](${link.href}): ${link.description}`;
+        return link.description ? `- [${link.title}](${link.href}): ${link.description}` : `- [${link.title}](${link.href})`;
       }).join("\n") || ""
     );
   }
@@ -29,6 +29,6 @@ export default eventHandler(async (event) => {
       (options.notes || []).map((note) => `- ${note}`).join("\n")
     );
   }
-  setHeader(event, "Content-Type", "text/plain");
+  setHeader(event, "Content-Type", "text/plain; charset=utf-8");
   return document.join("\n\n");
 });

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

@@ -2,7 +2,11 @@ import { createHooks } from "hookable";
 import { useNitroApp } from "#imports";
 export const llmsHooks = createHooks();
 llmsHooks.beforeEach(() => {
-  console.warn("[nuxt-llms] `llmsHooks` are deprecated and will be removed in future versions. Use `useNitroApp().hooks.hook('llms:generate', (event, options) => {})` instead");
+  const hooks = Object.values(llmsHooks._hooks || {});
+  const hasRegisteredHook = hooks.some((hooksList) => Array.isArray(hooksList) && hooksList.length > 0);
+  if (hasRegisteredHook) {
+    console.warn("[nuxt-llms] `llmsHooks` are deprecated and will be removed in future versions. Use `useNitroApp().hooks.hook('llms:generate', (event, options) => {})` instead");
+  }
 });
 export function onLLMsGenerate(cb) {
   return useNitroApp().hooks.hook("llms:generate", cb);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-llms",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Generate llms.txt documentation for your Nuxt application",
   "repository": {
     "type": "git",
@@ -39,22 +39,22 @@
     "verify": "npm run dev:prepare && npm run lint && npm run test && npm run typecheck"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.15.4"
+    "@nuxt/kit": "^3.16.1"
   },
   "devDependencies": {
     "nuxt-llms": "link:.",
-    "@nuxt/devtools": "^2.1.0",
-    "@nuxt/eslint-config": "^1.1.0",
+    "@nuxt/devtools": "^2.3.1",
+    "@nuxt/eslint-config": "^1.2.0",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.15.4",
-    "@nuxt/test-utils": "^3.15.4",
+    "@nuxt/schema": "^3.16.1",
+    "@nuxt/test-utils": "^3.17.2",
     "@types/node": "latest",
-    "changelogen": "^0.5.7",
-    "eslint": "^9.20.1",
-    "nuxt": "^3.15.4",
+    "changelogen": "^0.6.1",
+    "eslint": "^9.23.0",
+    "nuxt": "^3.16.1",
     "typescript": "~5.6.0",
-    "vitest": "^3.0.6",
+    "vitest": "^3.0.9",
     "vue-tsc": "^2.2.2"
   },
-  "packageManager": "pnpm@10.4.1"
+  "packageManager": "pnpm@10.6.5"
 }