@rspress/plugin-llms 2.0.0-beta.1 → 2.0.0-beta.2

package/dist/index.d.ts

@@ -355,12 +355,21 @@ export declare interface Options {
      */
     mdFiles?: boolean;
     /**
-     * Whether to generate llms.full.txt.
+     * Whether to generate llms-full.txt.
      * @default true
      */
     llmsFullTxt?: boolean;
+    /**
+     * Whether to include some routes from llms.txt.
+     * @param context
+     * @default (context) => context.page.lang === config.lang
+     */
+    include?: (context: {
+        page: PageIndexInfo;
+    }) => boolean;
     /**
      * Whether to exclude some routes from llms.txt.
+     * exclude will trigger after include
      * @default undefined
      */
     exclude?: (context: {

package/dist/index.js

@@ -5904,7 +5904,7 @@ function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title,
     }
     let hasOthers = false;
     const otherLines = [];
-    otherLines.push('\n## Others\n');
+    otherLines.push('\n## Other\n');
     for (const page of others){
         const { routePath, lang, title, frontmatter } = page;
         if ('/' === routePath || routePath === `/${lang}/`) continue;
@@ -5919,18 +5919,21 @@ function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title,
 function generateLlmsFullTxt(pageDataArray, navList, others) {
     const lines = [];
     for(let i = 0; i < navList.length; i++){
-        const nav = navList[i];
         const pages = pageDataArray[i];
-        if (0 === pages.length) continue;
-        const title = nav.text;
-        lines.push(`# ${title}\n`);
-        for (const page of pages){
+        if (0 !== pages.length) for (const page of pages){
+            lines.push(`---
+url: ${routePathToMdPath(page.routePath)}
+---
+`);
             lines.push(page.mdContent ?? page._flattenContent ?? page.content);
             lines.push('\n');
         }
     }
-    lines.push('# Others\n');
     for (const page of others){
+        lines.push(`---
+url: ${routePathToMdPath(page.routePath)}
+---
+`);
         lines.push(page.mdContent ?? page._flattenContent ?? page.content);
         lines.push('\n');
     }
@@ -20903,14 +20906,14 @@ function mdxToMd(content, filepath, docDirectory, routeService) {
         path: filepath
     });
 }
-const rsbuildPluginLlms = ({ pageDataList, routes, titleRef, descriptionRef, sidebar, baseRef, docDirectoryRef, routeServiceRef, nav, rspressPluginOptions })=>({
+const rsbuildPluginLlms = ({ pageDataList, routes, titleRef, descriptionRef, langRef, sidebar, baseRef, docDirectoryRef, routeServiceRef, nav, rspressPluginOptions })=>({
         name: 'rsbuild-plugin-llms',
         async setup (api) {
-            const { llmsTxt = true, mdFiles = true, llmsFullTxt = true, exclude } = rspressPluginOptions;
+            const { llmsTxt = true, mdFiles = true, llmsFullTxt = true, include, exclude } = rspressPluginOptions;
             api.onBeforeBuild(async ()=>{
                 const base = baseRef.current;
                 const docDirectory = docDirectoryRef.current;
-                const newPageDataList = mergeRouteMetaWithPageData(routes, pageDataList, exclude);
+                const newPageDataList = mergeRouteMetaWithPageData(routes, pageDataList, langRef.current, include, exclude);
                 const navList = Array.isArray(nav) ? nav.map((i)=>{
                     const nav = i.nav.default;
                     const lang = i.lang;
@@ -20983,15 +20986,21 @@ const rsbuildPluginLlms = ({ pageDataList, routes, titleRef, descriptionRef, sid
                         stage: 'additional'
                     }, async ({ compilation, sources })=>{
                         const source = new sources.RawSource(llmsFullTxtContent);
-                        compilation.emitAsset('llms.full.txt', source);
+                        compilation.emitAsset('llms-full.txt', source);
                     });
                 }
             });
         }
     });
-function mergeRouteMetaWithPageData(routeMetaList, pageDataList, exclude) {
+function mergeRouteMetaWithPageData(routeMetaList, pageDataList, lang, include, exclude) {
     const m = new Map(pageDataList.filter((pageData)=>{
-        if (exclude) return !exclude?.({
+        if (include) return include({
+            page: pageData
+        });
+        if (lang) return pageData.lang === lang;
+        return true;
+    }).filter((pageData)=>{
+        if (exclude) return !exclude({
             page: pageData
         });
         return true;
@@ -21042,6 +21051,9 @@ function pluginLlms(options = {}) {
     const descriptionRef = {
         current: ''
     };
+    const langRef = {
+        current: ''
+    };
     const pageDataList = [];
     const routes = [];
     const sidebar = {};
@@ -21073,6 +21085,7 @@ function pluginLlms(options = {}) {
             nav.push(...configNav);
             titleRef.current = config.title;
             descriptionRef.current = config.description;
+            langRef.current = config.lang;
             baseRef.current = config.base ?? '/';
             docDirectoryRef.current = config.root ?? 'docs';
         },
@@ -21084,6 +21097,7 @@ function pluginLlms(options = {}) {
                     routes,
                     titleRef,
                     descriptionRef,
+                    langRef,
                     sidebar,
                     docDirectoryRef,
                     routeServiceRef,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-llms",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.2",
   "description": "A plugin for rspress to generate llms.txt, llms-full.txt, md files to let llm understand your website.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -34,11 +34,11 @@
     "typescript": "^5.8.2",
     "vfile": "^6.0.3",
     "@rspress/config": "1.0.0",
-    "@rspress/shared": "2.0.0-beta.1"
+    "@rspress/shared": "2.0.0-beta.2"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.0-beta.1",
-    "@rspress/runtime": "^2.0.0-beta.1"
+    "@rspress/core": "^2.0.0-beta.2",
+    "@rspress/runtime": "^2.0.0-beta.2"
   },
   "engines": {
     "node": ">=18.0.0"