Add llms.txt generation for GitHub Pages deployment#650
Conversation
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
aaronpowell
left a comment
There was a problem hiding this comment.
@copilot I want the file to be generated as part of the website publishing step and available on the github pages site not just loose in the repo
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Done! The llms.txt file is now generated as part of the website:build step and will be available at https://github.github.io/awesome-copilot/llms.txt on the GitHub Pages site. Changes in commit 7e23ac9:
|
There was a problem hiding this comment.
Pull request overview
Adds automated generation of an llms.txt index (per llmstxt.org) so LLMs can discover agents, prompts, instructions, and skills in this repository.
Changes:
- Adds
eng/generate-llms-txt.mjsto scan repository resources and generate a spec-shapedllms.txt. - Updates
package.jsonto add anllms:generatescript and run it as part ofnpm run build. - Adds the generated
llms.txtfile and documents it inREADME.md.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| package.json | Adds llms:generate and runs it in the build pipeline. |
| eng/generate-llms-txt.mjs | New generator script that extracts metadata and emits llms.txt. |
| llms.txt | Generated catalog of agents/prompts/instructions/skills and repo docs links. |
| README.md | Documents the presence/purpose of llms.txt. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: aaronpowell <434140+aaronpowell@users.noreply.github.com>
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
Adds automated generation of
llms.txtfollowing the llmstxt.org specification. Enables LLMs to discover and index all repository resources (484 total: 145 agents, 139 prompts, 168 instructions, 32 skills). The file is generated during the website build process and deployed to GitHub Pages at https://github.github.io/awesome-copilot/llms.txt.Implementation:
eng/generate-llms-txt.mjs: Extracts metadata from all resource types, handles multiline descriptions, generates spec-compliant Markdown. Accepts optional output directory parameter. Skill links point to SKILL.md files for consistency with repository documentation.package.json: Addedllms:generatescript, integrated intowebsite:buildpipeline to generate llms.txt inwebsite/publicdirectory.gitignore: Added llms.txt to ignore list (generated file, not committed to repository)README.md: Added documentation section linking to GitHub Pages URLKey decisions:
yaml-parser.mjsutilities for consistencyskills/agentic-eval/SKILL.md) matching the pattern used throughout the repositoryType of Contribution
Additional Notes
The
llms.txtfile provides a machine-readable catalog of all repository resources. LLMs can parse this to understand available agents, prompts, instructions, and skills without traversing the entire repository structure. The file is dynamically generated during website builds and served from GitHub Pages, ensuring it stays in sync with repository changes without cluttering the git history.All resource links in the generated file use consistent patterns: agents, prompts, and instructions link to their respective
.mdfiles, while skills link toSKILL.mdentrypoint files, matching the conventions used in repository documentation.By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.