Skip to content

Commit

Permalink
docs: llms_full option
Browse files Browse the repository at this point in the history
  • Loading branch information
farnabaz committed Feb 20, 2025
1 parent c72837a commit 2fabe9d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,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 usefull to add any information about the application or documentation itself.
- `llmsFull`: 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

Expand All @@ -100,6 +103,21 @@ The `/llms.txt` route generates a concise, structured documentation that follows

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 `llmsFull.title` and `llmsFull.description` in your `nuxt.config.ts`.

```ts
export default defineNuxtConfig({
llms: {
domain: 'https://example.com',
title: 'My Application',
llmsFull: {
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:
Expand Down

0 comments on commit 2fabe9d

Please sign in to comment.