Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Create llms.txt for vite.dev #19400

Open
1 of 4 tasks
okineadev opened this issue Feb 11, 2025 · 1 comment
Open
1 of 4 tasks

Create llms.txt for vite.dev #19400

okineadev opened this issue Feb 11, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@okineadev
Copy link

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

I suggest adding Vite documentation for LLMs in Markdown format, which will be available at https://vite.dev/llms.txt

This documentation format for LLMs has already been adopted by many projects, including Svelte - https://svelte.dev/llms.txt

It would be nice to have an LLM-friendly documentation format like this one for people: https://vite.dev/guide/features.html

And this one for LLM in pure Markdown without any HTML, CSS and everything unnecessary: https://vite.dev/guide/features.md

Your Suggestion for Changes

We can create a basic llms.txt with just a description and links to the documentation (regular, not for LLMs) as in FastHTML:

# FastHTML

> FastHTML is a python library which brings together Starlette, Uvicorn, HTMX, and fastcore's `FT` "FastTags" into a library for creating server-rendered hypermedia applications.

Important notes:

- Although parts of its API are inspired by FastAPI, it is *not* compatible with FastAPI syntax and is not targeted at creating API services
- FastHTML is compatible with JS-native web components and any vanilla JS library, but not with React, Vue, or Svelte.

## Docs

- [FastHTML quick start](https://docs.fastht.ml/path/quickstart.html.md): A brief overview of many FastHTML features
- [HTMX reference](https://raw.githubusercontent.com/path/reference.md): Brief description of all HTMX attributes, CSS classes, headers, events, extensions, js lib methods, and config options

## Examples

- [Todo list application](https://raw.githubusercontent.com/path/adv_app.py): Detailed walk-thru of a complete CRUD app in FastHTML showing idiomatic use of FastHTML and HTMX patterns.

## Optional

- [Starlette full documentation](https://gist.githubusercontent.com/path/starlette-sml.md): A subset of the Starlette documentation useful for FastHTML development.

This is a basic example that can be implemented quickly and easily

But you can do better thanks to the automatic generation of documentation for LLMs, as Svelte and Prisma did:

Reproduction

No response

Steps to reproduce

No response
@okineadev okineadev added the documentation Improvements or additions to documentation label Feb 11, 2025
@okineadev
Copy link
Author

okineadev commented Feb 17, 2025 •
edited
Loading

By the way, is there any plugin for vitepress that automatically generates llms.txt pages?
I've only seen https://github.com/aklinker1/vitepress-knowledge, it's used in https://wxt.dev - https://wxt.dev/knowledge/docs.txt

Only the name of the plugin worries me, because in my opinion it would be better to be called vitepress-llms or something like that, because the name vitepress-knowledge does not immediately guess that it generates documentation for LLMs

UPD: Found another plugin - https://github.com/saschaseniuk/vite-plugin-llms

@okineadev okineadev mentioned this issue Feb 17, 2025
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@okineadev
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy