@rspress/plugin-llms 2.0.4 → 2.0.6

package/dist/index.js

@@ -14,10 +14,11 @@ function routePathToMdPath(routePath, base) {
 function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title, description, base) {
     const lines = [];
     const { onAfterLlmsTxtGenerate, onLineGenerate, onTitleGenerate } = llmsTxtOptions;
+    if (!onTitleGenerate && !title) logger.warn('No `title` is configured in your Rspress setup. Please set `title` in rspress.config.ts so llms.txt can include an appropriate heading.');
     const summary = onTitleGenerate ? onTitleGenerate({
         title,
         description
-    }) : `# ${title}${description ? `\n\n> ${description}` : ''}`;
+    }) : title ? `# ${title}${description ? `\n\n> ${description}` : ''}` : '';
     for(let i = 0; i < navList.length; i++){
         const nav = navList[i];
         const pages = pageDataArray[i];
@@ -43,7 +44,8 @@ function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title,
         hasOthers = true;
     }
     if (hasOthers) lines.push(...otherLines);
-    const llmsTxt = `${summary}\n${lines.join('\n')}`;
+    let llmsTxt;
+    llmsTxt = summary ? lines.length > 0 ? `${summary}\n${lines.join('\n')}` : summary : lines.join('\n').trimStart();
     return onAfterLlmsTxtGenerate ? onAfterLlmsTxtGenerate(llmsTxt) : llmsTxt;
 }
 function generateLlmsFullTxt(pageDataArray, navList, others, base) {
@@ -141,6 +143,25 @@ const rsbuildPluginLlms = ({ disableSSGRef, baseRef, pageDataList, routes, title
                 const defaultVersion = defaultVersionRef.current;
                 const isMultiVersion = versions.length > 0;
                 const newPageDataList = mergeRouteMetaWithPageData(routes, pageDataList, langRef.current, include, exclude);
+                const mdContents = {};
+                await Promise.all([
+                    ...newPageDataList.values()
+                ].map(async (pageData)=>{
+                    const content = pageData._flattenContent ?? pageData.content;
+                    const filepath = pageData._filepath;
+                    const isMD = 'mdx' !== node_path.extname(filepath).slice(1);
+                    let mdContent;
+                    try {
+                        mdContent = await normalizeMdFile(content, filepath, routeServiceRef.current, baseRef.current, 'boolean' != typeof mdFiles ? mdFiles?.mdxToMd ?? false : false, isMD, 'boolean' != typeof mdFiles ? mdFiles?.remarkPlugins ?? [] : []);
+                    } catch (e) {
+                        logger.debug('normalizeMdFile failed', pageData.routePath, e);
+                        mdContent = content;
+                    }
+                    const outFilePath = routePathToMdPath(pageData.routePath, '');
+                    const mdContentStr = mdContent.toString();
+                    mdContents[outFilePath] = mdContentStr;
+                    pageData.mdContent = mdContentStr;
+                }));
                 const versionList = isMultiVersion ? versions : [
                     ''
                 ];
@@ -193,23 +214,6 @@ const rsbuildPluginLlms = ({ disableSSGRef, baseRef, pageDataList, routes, title
                         });
                     }
                 }
-                const mdContents = {};
-                await Promise.all([
-                    ...newPageDataList.values()
-                ].map(async (pageData)=>{
-                    const content = pageData._flattenContent ?? pageData.content;
-                    const filepath = pageData._filepath;
-                    const isMD = 'mdx' !== node_path.extname(filepath).slice(1);
-                    let mdContent;
-                    try {
-                        mdContent = await normalizeMdFile(content, filepath, routeServiceRef.current, baseRef.current, 'boolean' != typeof mdFiles ? mdFiles?.mdxToMd ?? false : false, isMD, 'boolean' != typeof mdFiles ? mdFiles?.remarkPlugins ?? [] : []);
-                    } catch (e) {
-                        logger.debug('normalizeMdFile failed', pageData.routePath, e);
-                        mdContent = content;
-                    }
-                    const outFilePath = routePathToMdPath(pageData.routePath, '');
-                    mdContents[outFilePath] = mdContent.toString();
-                }) ?? []);
                 if (mdFiles) api.processAssets({
                     environments: disableSSG ? [
                         'web'
@@ -266,12 +270,11 @@ function organizeBySidebar(sidebar, pages) {
     const currSidebar = getSidebarDataGroup(sidebar, pageItem.routePath);
     if (0 === currSidebar.length) return;
     const orderList = flatSidebar(currSidebar);
+    const normalizeLink = (p)=>p.replace(/\.html$/, '').replace(/\/index$/, '/');
     pages.sort((a, b)=>{
-        let aIndex = orderList.findIndex((order)=>matchPath(order, a.routePath));
-        if (-1 === aIndex) aIndex = Number.MAX_SAFE_INTEGER;
-        let bIndex = orderList.findIndex((order)=>matchPath(order, b.routePath));
-        if (-1 === bIndex) bIndex = Number.MAX_SAFE_INTEGER;
-        return aIndex - bIndex;
+        const aIndex = orderList.findIndex((order)=>matchPath(normalizeLink(order), a.routePath));
+        const bIndex = orderList.findIndex((order)=>matchPath(normalizeLink(order), b.routePath));
+        return (-1 === aIndex ? Number.MAX_SAFE_INTEGER : aIndex) - (-1 === bIndex ? Number.MAX_SAFE_INTEGER : bIndex);
     });
 }
 function getDefaultOptions(lang, langs) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-llms",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "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": {
@@ -35,10 +35,10 @@
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.57.6",
+    "@microsoft/api-extractor": "^7.57.7",
     "@rsbuild/core": "2.0.0-beta.6",
     "@rsbuild/plugin-react": "~1.4.5",
-    "@rslib/core": "0.19.6",
+    "@rslib/core": "0.20.0",
     "@types/hast": "^3.0.4",
     "@types/node": "^22.8.1",
     "@types/react": "^19.2.14",
@@ -49,7 +49,7 @@
     "@rspress/config": "1.0.0"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.4"
+    "@rspress/core": "^2.0.6"
   },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"