Skip to content

RFC: feat: add llms.txt generation #1098

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 1 commit into
base: main
Choose a base branch
from

Conversation

muningis
Copy link
Contributor

@muningis muningis commented Mar 22, 2025

This adds generation of llms.txt, which is used there and there by various libraries, to expose API, documentationn, and information in format, which is easier to be consumed by LLMS. Not yet de-facto standard. Before merging however, would probably be good to agree on a format.

Right now it just strips frontmatter (subject to change/discussion) MDX's imports and trims empty space at start and end of each Markdown file. As a minimum, probably, worth to include description from frontmatter in each section. (Using some AST manipulation would be much more effecient though probably)


More here :https://llmstxt.org/
Example in the wild: https://hono.dev/llms-full.txt, https://sdk.vercel.ai/llms.txt

Copy link

vercel bot commented Mar 22, 2025

@muningis is attempting to deploy a commit to the Valibot Team on Vercel.

A member of the Team first needs to authorize it.

@fabian-hiller
Copy link
Owner

Thank you so much for this contribution! I will try to review it this week and provide feedback.

@fabian-hiller fabian-hiller self-assigned this Mar 25, 2025
@fabian-hiller fabian-hiller added the documentation Improvements or additions to documentation label Mar 25, 2025
Copy link

pkg-pr-new bot commented Mar 25, 2025

Open in Stackblitz

npm i https://pkg.pr.new/valibot@1098

commit: 70a45d2

@fabian-hiller
Copy link
Owner

Sorry for the delay. I will get back to this PR as soon as possible, but it may take one or two weeks.

@fabian-hiller
Copy link
Owner

I plan to review this PR in the next few days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants