Nuxt LLMs

To use nuxt-llms in your Nuxt application, install the module, register it in your configuration, and provide the required application details.

1. Install the module:

   npm i nuxt-llms

2. Register in nuxt.config.ts:

   export default defineNuxtConfig({
     modules: ['nuxt-llms']
   })

3. Configure application details: You must provide at least the domain. You can also define title, description, and custom sections containing links.

Once configured, the documentation is available at /llms.txt.

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',
          },
        ],
      },
    ],
  },
})

If you are developing a Nuxt module and want to contribute to the user's LLM documentation, you must register a server plugin within your module's runtime.

1. Create the server plugin in your module's runtime directory:

   // module/runtime/server/plugins/my-module-llms.ts
   export default defineNitroPlugin((nitroApp) => {
     nitroApp.hooks.hook('llms:generate', (event, options) => {
       options.sections.push({
         title: 'My Module',
         description: 'Documentation for my module features',
         links: []
       })
     })
   })

2. Register the plugin in your module's setup function using addServerPlugin:

   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'))
     }
   })

The llms configuration object in nuxt.config.ts controls the generation of documentation.

You can dynamically modify or add content to your documentation by creating a server plugin in your server/plugins directory using the provided Nitro hooks.

llms:generate(event, options)

Called for every request to /llms.txt. Use this to modify the structured options object (e.g., adding new sections or links).

• event: H3Event - The current request event.
• options: ModuleOptions - The module options you can modify.

llms:generate:llms-full(event, options, contents)

Called for every request to /llms-full.txt. Use this to append custom markdown content.

• event: H3Event - The current request event.
• options: ModuleOptions - The module options.
• contents: string[] - An array of content sections you can modify or append to.

// server/plugins/llms.ts
export default defineNitroPlugin((nitroApp) => {
  // Method 1: Modifying structured llms.txt
  nitroApp.hooks.hook('llms:generate', (event, options) => {
    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: Adding raw markdown to llms-full.txt
  nitroApp.hooks.hook('llms:generate:llms-full', (event, options, contents) => {
    contents.push(`## API Authentication\n\n### Bearer Token\nTo authenticate, use:\n\`\`\`\nAuthorization: Bearer <token>\n\`\`\``)
  })
})

The nuxt-llms module is configured using the llms key in your nuxt.config.ts. It requires a domain property to function correctly.

Key configuration options include:

• domain: The base URL/domain for your documentation (Required).
• title: The title of your documentation.
• description: A description of your documentation.
• notes: An array of notes to include.
• sections: An array of documentation sections.
• prerender: Boolean determining if /llms.txt and /llms-full.txt should be prerendered. Defaults to true.
• full: An object used to enable the /llms-full.txt endpoint. It accepts title and description properties.

export default defineNuxtModule<ModuleOptions>({
  llms: {
    domain: 'https://example.com',
    title: 'My Docs',
    description: 'Documentation for my project',
    sections: [
      // ... your sections
    ],
    full: {
      title: 'Full Documentation',
      description: 'Complete documentation set'
    }
  }
})

The ModuleOptions interface defines the configuration for the nuxt-llms module. You can use these keys in your nuxt.config.ts to define how your documentation is structured and served.

Key options include:

• domain: The domain of your documentation (required).
• title (optional): The title of your documentation.
• description (optional): The description of your documentation.
• sections: An array of LLMsSection objects defining the structure of your documentation.
• full (optional): Configuration for the full documentation content, requiring a title and description.
• notes (optional): An array of strings for additional notes.
• prerender (optional): Determines if /llms.txt and /llms-full.txt are prerendered at build time. Defaults to true. Set to false to serve them dynamically (e.g., via ISR).

export interface ModuleOptions {
  domain: string
  full?: {
    title: string
    description: string
  }
  sections: Array<LLMsSection>
  title?: string
  description?: string
  notes?: string[]
  prerender?: boolean
}

The llmsHooks object and the helper functions onLLMsGenerate and onLLMsGenerateFull are deprecated. To customize the generation of llms.txt or llms-full.txt, you should use the Nitro runtime hooks via useNitroApp().hooks.hook() instead.

Recommended Hook Usage

Instead of using the deprecated llmsHooks or onLLMsGenerate helpers, register your callbacks using the following hook names:

• llms:generate: Triggered when generating the standard llms.txt file. The callback receives (event, options).
• llms:generate:full: Triggered when generating the llms-full.txt file. The callback receives (event, options, contents) where contents is an array of strings.

If you see the warning [nuxt-llms] llmsHooks are deprecated... in your console, you are using the old API and should migrate to the Nitro hooks pattern.

// Use the Nitro runtime hooks instead of the deprecated llmsHooks
const nitroApp = useNitroApp()

// For llms.txt
nitroApp.hooks.hook('llms:generate', (event, options) => {
  // Custom logic for llms.txt generation
})

// For llms-full.txt
nitroApp.hooks.hook('llms:generate:full', (event, options, contents) => {
  // Custom logic for llms-full.txt generation
})