From 3d530b72a8a84e51c89eac9bf295c19dd0dde0da Mon Sep 17 00:00:00 2001 From: Max Thirouin Date: Thu, 11 Sep 2025 19:12:11 +0200 Subject: [PATCH] Add docusaurus-plugin-generate-llms-txt to generate llms.txt for AI-friendly documentation - Install docusaurus-plugin-generate-llms-txt package - Configure plugin in docusaurus.config.js - Generate llms.txt file automatically during build and dev - File is accessible at /llms.txt URL following llms.txt specification --- apps/website/.gitignore | 2 ++ apps/website/docusaurus.config.js | 5 ++++- apps/website/package.json | 1 + package-lock.json | 34 +++++++++++++++++++++++++++++++ 4 files changed, 41 insertions(+), 1 deletion(-) diff --git a/apps/website/.gitignore b/apps/website/.gitignore index a7270b53..d6e799fe 100644 --- a/apps/website/.gitignore +++ b/apps/website/.gitignore @@ -16,3 +16,5 @@ .env.production.local npm-debug.log* + +static/llms.txt diff --git a/apps/website/docusaurus.config.js b/apps/website/docusaurus.config.js index fafbf402..67cd258a 100644 --- a/apps/website/docusaurus.config.js +++ b/apps/website/docusaurus.config.js @@ -118,7 +118,10 @@ const config = { theme: prismThemes.github } }, - plugins: [require.resolve('docusaurus-lunr-search')] + plugins: [ + require.resolve('docusaurus-lunr-search'), + require.resolve('docusaurus-plugin-generate-llms-txt'), + ] }; export default config; diff --git a/apps/website/package.json b/apps/website/package.json index f4347b7a..49c49c99 100644 --- a/apps/website/package.json +++ b/apps/website/package.json @@ -14,6 +14,7 @@ "@mdx-js/react": "^3.1.0", "clsx": "^2.0.0", "docusaurus-lunr-search": "^3.6.0", + "docusaurus-plugin-generate-llms-txt": "^0.0.1", "prism-react-renderer": "^2.4.1", "react": "^18.1.0", "react-dom": "^18.1.0" diff --git a/package-lock.json b/package-lock.json index 113642af..5d8945fc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -74,6 +74,7 @@ "@mdx-js/react": "^3.1.0", "clsx": "^2.0.0", "docusaurus-lunr-search": "^3.6.0", + "docusaurus-plugin-generate-llms-txt": "^0.0.1", "prism-react-renderer": "^2.4.1", "react": "^18.1.0", "react-dom": "^18.1.0" @@ -12449,6 +12450,39 @@ "url": "https://opencollective.com/unified" } }, + "node_modules/docusaurus-plugin-generate-llms-txt": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-generate-llms-txt/-/docusaurus-plugin-generate-llms-txt-0.0.1.tgz", + "integrity": "sha512-XlUeQ23anYc85I1k9pO61fWcMWcUs8Tx7n3zqIus/1wjZ1mjezm0lOX9jymu9Y2MAi3/YQbDxsfo4kZrMf5q6A==", + "license": "MIT", + "dependencies": { + "js-yaml": "^4.1.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@docusaurus/core": ">=2.0.0" + } + }, + "node_modules/docusaurus-plugin-generate-llms-txt/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "license": "Python-2.0" + }, + "node_modules/docusaurus-plugin-generate-llms-txt/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, "node_modules/dom-accessibility-api": { "version": "0.5.16", "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz",