Skip to content

adds llm.txt standard #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

rachfop
Copy link

@rachfop rachfop commented May 16, 2025

Hey, I created a plugin that adds llms.txt and llms-full.txt to any Docusaurus site.

If you aren't familiar with llms.txt you can read the full standard (created by Jeremy Howard) here.

TLDR:

  • /llms.txt is an index file containing links with brief descriptions of the content. An LLM or agent must follow these links to access detailed information.
  • /llms-full.txt includes all the detailed content directly in a single file, eliminating the need for additional navigation.

This is useful when for example, you're using an IDE with AI (Cursor or Windsurf) you can @ the llms.txt URL and the IDE will apply that to the context of the prompt allowing up-to-date information.

For example:

https://docs.resonatehq.io/llms.txt
https://docs.resonatehq.io/llms-full.txt

Feel free to checkout the preview running in this fork (I won't have access to your Vercel deployments) or try running it locally.

LangChain has a good on llmstxt as well if you want more info.

Copy link

vercel bot commented May 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 9:13pm

@flossypurse
Copy link
Contributor

@rachfop !!!!! TY! Very awesome.

@flossypurse flossypurse self-assigned this May 26, 2025
@flossypurse flossypurse added the enhancement New feature or request label May 26, 2025
@flossypurse flossypurse moved this to In progress in Resonate Engineering May 26, 2025
@flossypurse flossypurse self-requested a review May 26, 2025 16:15
@flossypurse flossypurse assigned rachfop and unassigned flossypurse May 26, 2025
@flossypurse
Copy link
Contributor

@rachfop !!!!! TY! Very awesome.

Hey! Would love to catch up!
I'm in this Discord a lot - https://resonatehq.io/discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

2 participants