You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Generate & prerenders `/llms_full.txt` when enabled
19
+
- Generate & prerenders `/llms-full.txt` when enabled
20
20
- Customizable sections directly from your `nuxt.config.ts`
21
21
- Integrates with Nuxt modules and your application via the runtime hooks system
22
22
@@ -84,9 +84,9 @@ That's it! You can visit `/llms.txt` to see the generated documentation ✨
84
84
-`description`: The description of the link
85
85
-`href`(required): The href of the link
86
86
-`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.
87
-
-`full`: The `llms_full.txt` configuration. Setting this option will enable the `llms_full.txt` route.
88
-
-`title`: The title of the llms_full documentation
89
-
-`description`: The description of the llms_full documentation
87
+
-`full`: The `llms-full.txt` configuration. Setting this option will enable the `llms-full.txt` route.
88
+
-`title`: The title of the llms-full documentation
89
+
-`description`: The description of the llms-full documentation
90
90
91
91
## Documentation Formats
92
92
@@ -101,11 +101,11 @@ The `/llms.txt` route generates a concise, structured documentation that follows
101
101
- Links with titles, descriptions, and URLs
102
102
- Optional notes section
103
103
104
-
### llms_full.txt
104
+
### llms-full.txt
105
105
106
-
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.
106
+
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.
107
107
108
-
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`.
108
+
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`.
109
109
110
110
```ts
111
111
exportdefaultdefineNuxtConfig({
@@ -135,9 +135,9 @@ This hook is called for every request to `/llms.txt`. Use this hook to modify th
135
135
-`options`: ModuleOptions - The module options that you can modify to add sections, links, etc.
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.
228
+
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.
229
229
230
230
All you need is to install both modules and write your content files in the `content` directory.
0 commit comments