diff --git a/docusaurus.config.js b/docusaurus.config.js index 378d4b7a..50b1ac47 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -279,6 +279,21 @@ const config = { }, ], require.resolve('docusaurus-plugin-image-zoom'), + [ + 'docusaurus-plugin-llms', + { + generateLLMsTxt: true, + generateLLMsFullTxt: true, + docsDir: 'docs', + version: 'latest', + title: 'ScalarDB Documentation', + description: 'Cloud-native universal transaction manager', + // Content cleaning options + excludeImports: true, // This configuration currently option doesn't seem to work as expected. I don't think it's a major issue, but we should upgrade the plugin when a new version is available to see if the issue is fixed. + removeDuplicateHeadings: true, // This configuration currently option doesn't seem to work as expected. I don't think it's a major issue, but we should upgrade the plugin when a new version is available to see if the issue is fixed. + includeUnmatchedLast: true, + }, + ], [ '@docusaurus/plugin-pwa', { diff --git a/package-lock.json b/package-lock.json index a80ae881..ff524ece 100644 --- a/package-lock.json +++ b/package-lock.json @@ -28,6 +28,7 @@ "clsx": "^2.0.0", "docusaurus-lunr-search": "^3.3.2", "docusaurus-plugin-image-zoom": "^2.0.0", + "docusaurus-plugin-llms": "^0.1.5", "prism-react-renderer": "^2.3.0", "react": "^18.0.0", "react-cookie-consent": "9.0.0", @@ -8480,6 +8481,46 @@ "@docusaurus/theme-classic": ">=3.0.0" } }, + "node_modules/docusaurus-plugin-llms": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-llms/-/docusaurus-plugin-llms-0.1.5.tgz", + "integrity": "sha512-TKcHQG6MyTTleDdOFJL+5OpmW9Le6XGiagClgSX05GXhxD//4PQlY2Iq9HVETLBIsHVETVp8AxjZQ6e3E/fr/Q==", + "license": "MIT", + "dependencies": { + "gray-matter": "^4.0.3", + "minimatch": "^9.0.3" + }, + "engines": { + "node": ">=18.0" + }, + "peerDependencies": { + "@docusaurus/core": "^3.0.0" + } + }, + "node_modules/docusaurus-plugin-llms/node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/docusaurus-plugin-llms/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/dom-converter": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/dom-converter/-/dom-converter-0.2.0.tgz", diff --git a/package.json b/package.json index 54446a62..417bd753 100644 --- a/package.json +++ b/package.json @@ -33,6 +33,7 @@ "clsx": "^2.0.0", "docusaurus-lunr-search": "^3.3.2", "docusaurus-plugin-image-zoom": "^2.0.0", + "docusaurus-plugin-llms": "^0.1.5", "prism-react-renderer": "^2.3.0", "react": "^18.0.0", "react-cookie-consent": "9.0.0",