Add llms.txt support for documentation (#22463)

Matching uv.

Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Zanie Blue
2026-01-09 09:56:41 -06:00
committed by GitHub
parent 1094009790
commit a6df4a3be7
2 changed files with 37 additions and 0 deletions

View File

@@ -6,3 +6,4 @@ mkdocs-redirects==1.2.2
mdformat==1.0.0
mdformat-mkdocs==5.1.1
mkdocs-github-admonitions-plugin @ git+https://github.com/PGijsbers/admonitions.git#7343d2f4a92e4d1491094530ef3d0d02d93afbb7
mkdocs-llmstxt==0.2.0

View File

@@ -63,6 +63,42 @@ markdown_extensions:
plugins:
- search
- gh-admonitions
- llmstxt:
markdown_description: |
Ruff is an extremely fast Python linter and code formatter, written in Rust.
It can be used to replace Flake8 (plus dozens of plugins), Black, isort, pydocstyle,
pyupgrade, autoflake, and more, all while executing tens or hundreds of times faster
than any individual tool.
Ruff includes both a linter (`ruff check`) and a formatter (`ruff format`).
When fetching documentation, use explicit `index.md` paths for directories, e.g.,
`https://docs.astral.sh/ruff/editors/index.md`. This returns clean markdown instead
of rendered HTML with JS/CSS.
sections:
Getting started:
- installation.md
- tutorial.md
Configuration:
- configuration.md
Linter:
- linter.md
Formatter:
- formatter.md
- formatter/black.md
Editors:
- editors/index.md
- editors/setup.md
- editors/settings.md
- editors/features.md
- editors/migration.md
Integrations:
- integrations.md
Concepts:
- preview.md
- versioning.md
Reference:
- faq.md
extra_css:
- stylesheets/extra.css
extra_javascript: