nuxt / nuxt/modules

[Module Listing Request]: `nuxt-llms-txt`

Open Beginner friendly
#1,583 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.1k
Forks
354
Avg merge
10h 18m
Merged PRs (30d)
12

Description

Description

nuxt-llms-txt makes a Nuxt site readable by AI agents. With the module added and no configuration, a build produces a Markdown mirror of every page (/about.md), a sectioned llms.txt index following llmstxt.org, and optionally /llms-full.txt for one-shot ingestion. Routes are discovered during prerendering, so there is no route list to maintain.

Two things distinguish it from existing options:

  • It publishes your original Markdown. When a page comes from a Markdown source file, that file is what gets served — MDC components, fence labels and tables survive intact, rather than being flattened by an HTML round-trip. Pages that are not Markdown-backed fall back to HTML conversion automatically, so mixed sites work either way.
  • The index is organised. Sections are derived from the route tree, with descriptions taken from useSeoMeta / og:description / frontmatter. Per-locale indexes are generated automatically when @nuxtjs/i18n is present.

It also serves Markdown from the HTML route via Accept: text/markdown content negotiation, and advertises each mirror with a <link rel="alternate" type="text/markdown"> tag and matching Link: header. The conversion core is published separately as nuxt-llms-txt/core for use outside Nuxt.

Repository

https://github.com/ovion-dev/nuxt-llms-txt

npm

https://www.npmjs.com/package/nuxt-llms-txt

Nuxt Compatibility

Nuxt 4

Suggested metadata

Category: AI (alongside nuxt-llms), type: 3rd-party, website: https://ovion-dev.github.io/nuxt-llms-txt/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No target file or test is named. Start by inspecting the repository's module catalog structure and existing Nuxt module entries, then use the supplied repository, npm, compatibility, and metadata details to add the listing; done means the entry includes the requested category, type, website, and links.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt
Domain
content
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.