Skip to content

Commit c6cc516

Browse files
authoredMar 22, 2025··
chore: rename llms_full.txt to llms-full.txt
chore: rename `llms_full.txt` to `llms-full.txt`
1 parent b9f4da1 commit c6cc516

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed
 

Diff for: ‎README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Nuxt LLMs automatically generates [`llms.txt` markdown documentation](https://ll
1616
## Features
1717

1818
- Generates & prerenders `/llms.txt` automatically
19-
- Generate & prerenders `/llms_full.txt` when enabled
19+
- Generate & prerenders `/llms-full.txt` when enabled
2020
- Customizable sections directly from your `nuxt.config.ts`
2121
- Integrates with Nuxt modules and your application via the runtime hooks system
2222

@@ -84,9 +84,9 @@ That's it! You can visit `/llms.txt` to see the generated documentation ✨
8484
- `description`: The description of the link
8585
- `href`(required): The href of the link
8686
- `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
9090

9191
## Documentation Formats
9292

@@ -101,11 +101,11 @@ The `/llms.txt` route generates a concise, structured documentation that follows
101101
- Links with titles, descriptions, and URLs
102102
- Optional notes section
103103

104-
### llms_full.txt
104+
### llms-full.txt
105105

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.
107107

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`.
109109

110110
```ts
111111
export default defineNuxtConfig({
@@ -135,9 +135,9 @@ This hook is called for every request to `/llms.txt`. Use this hook to modify th
135135
- `options`: ModuleOptions - The module options that you can modify to add sections, links, etc.
136136

137137

138-
#### `llms:generate:llms_full(event, options, contents)`
138+
#### `llms:generate:llms-full(event, options, contents)`
139139

140-
This hook is called for every request to `/llms_full.txt`. It allows you to add custom content sections in any format.
140+
This hook is called for every request to `/llms-full.txt`. It allows you to add custom content sections in any format.
141141

142142
**Parameters:**
143143
- `event`: H3Event - The current request event
@@ -169,7 +169,7 @@ export default defineNitroPlugin((nitroApp) => {
169169

170170
// Method 2: Using the helper function
171171
nitroApp.hooks.hook('llms:generate:full', (event, options, contents) => {
172-
// Add detailed documentation to llms_full.txt
172+
// Add detailed documentation to llms-full.txt
173173
contents.push(`## API Authentication
174174
175175
### Bearer Token
@@ -225,7 +225,7 @@ export default defineNuxtModule({
225225

226226
### Nuxt Content
227227

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.
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.
229229

230230
All you need is to install both modules and write your content files in the `content` directory.
231231

Diff for: ‎src/module.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ export default defineNuxtModule<ModuleOptions>({
3737
{
3838
title: options.full.title,
3939
description: options.full.description,
40-
href: `${options.domain}/llms_full.txt`,
40+
href: `${options.domain}/llms-full.txt`,
4141
},
4242
],
4343
})
44-
addServerHandler({ route: '/llms_full.txt', handler: resolve('./runtime/server/routes/llms_full.txt.get') })
45-
addPrerenderRoutes('/llms_full.txt')
44+
addServerHandler({ route: '/llms-full.txt', handler: resolve('./runtime/server/routes/llms-full.txt.get') })
45+
addPrerenderRoutes('/llms-full.txt')
4646
}
4747
},
4848
})

0 commit comments

Comments
 (0)
Please sign in to comment.