@rspress/plugin-llms 2.0.0-beta.27 → 2.0.0-beta.29

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { PageIndexInfo } from '@rspress/core';
+import type { PluggableList } from 'unified';
 import type { RspressPlugin } from '@rspress/core';
 
 /**
@@ -23,9 +24,15 @@ export declare interface LlmsTxt {
 
 declare interface MdFiles {
     /**
+     * Whether to convert mdx to md.
      * @default false
      */
-    mdxToMd: boolean;
+    mdxToMd?: boolean;
+    /**
+     * Allow users to customize remarkPlugins and edit the content of generated md files.
+     * @default []
+     */
+    remarkPlugins?: PluggableList;
 }
 
 export declare interface Options {
@@ -43,8 +50,7 @@ export declare interface Options {
     llmsFullTxt?: false | LlmsFullTxt;
     /**
      * Whether to include some routes from llms.txt.
-     * @param context
-     * @default (context) => context.page.lang === config.lang
+     * @default undefined
      */
     include?: (context: {
         page: PageIndexInfo;

package/dist/index.js

@@ -90,8 +90,8 @@ const mdxToMdPlugin = ()=>(tree)=>{
         });
     };
 function noopPlugin() {}
-function normalizeMdFile(content, filepath, routeService, base, mdxToMd, isMd) {
-    return unified().use(remark_parse).use(isMd ? noopPlugin : remark_mdx).use(remarkFileCodeBlock, {
+function normalizeMdFile(content, filepath, routeService, base, mdxToMd, isMd, remarkPlugins) {
+    const compiler = unified().use(remark_parse).use(isMd ? noopPlugin : remark_mdx).use(remarkFileCodeBlock, {
         filepath
     }).use(!isMd && mdxToMd ? mdxToMdPlugin : noopPlugin).use(remarkLink, {
         cleanUrls: '.md',
@@ -101,7 +101,8 @@ function normalizeMdFile(content, filepath, routeService, base, mdxToMd, isMd) {
             autoPrefix: true
         },
         __base: base
-    }).use(remark_stringify).process({
+    }).use(remarkPlugins).use(remark_stringify);
+    return compiler.process({
         value: content,
         path: filepath
     });
@@ -112,7 +113,8 @@ const rsbuildPluginLlms = ({ disableSSGRef, baseRef, pageDataList, routes, title
             const { llmsTxt = {
                 name: 'llms.txt'
             }, mdFiles = {
-                mdxToMd: false
+                mdxToMd: false,
+                remarkPlugins: []
             }, llmsFullTxt = {
                 name: 'llms-full.txt'
             }, include, exclude } = rspressPluginOptions;
@@ -163,7 +165,7 @@ const rsbuildPluginLlms = ({ disableSSGRef, baseRef, pageDataList, routes, title
                     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, isMD)).toString();
+                        mdContent = (await normalizeMdFile(content, filepath, routeServiceRef.current, baseRef.current, 'boolean' != typeof mdFiles ? mdFiles?.mdxToMd ?? false : false, isMD, 'boolean' != typeof mdFiles ? mdFiles?.remarkPlugins ?? [] : [])).toString();
                     } catch (e) {
                         logger.debug('normalizeMdFile failed', pageData.routePath, e);
                         mdContent = content;
@@ -243,8 +245,10 @@ function organizeBySidebar(sidebar, pages) {
     if (0 === currSidebar.length) return;
     const orderList = flatSidebar(currSidebar);
     pages.sort((a, b)=>{
-        const aIndex = orderList.findIndex((order)=>matchPath(order, a.routePath));
-        const bIndex = orderList.findIndex((order)=>matchPath(order, b.routePath));
+        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;
     });
 }
@@ -257,9 +261,6 @@ function getDefaultOptions(lang, langs) {
             },
             llmsFullTxt: {
                 name: 'llms-full.txt'
-            },
-            include ({ page }) {
-                return page.lang === l;
             }
         };
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-llms",
-  "version": "2.0.0-beta.27",
+  "version": "2.0.0-beta.29",
   "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": {
@@ -32,18 +32,17 @@
     "remark-parse": "^11.0.0",
     "remark-stringify": "^11.0.0",
     "unified": "^11.0.5",
-    "unist-util-visit": "^5.0.0",
-    "unist-util-visit-children": "^3.0.0"
+    "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.10",
-    "@rsbuild/core": "~1.4.15",
+    "@microsoft/api-extractor": "^7.52.11",
+    "@rsbuild/core": "~1.4.16",
     "@rsbuild/plugin-react": "~1.3.5",
     "@rsbuild/plugin-sass": "~1.3.5",
-    "@rslib/core": "0.11.2",
+    "@rslib/core": "0.12.2",
     "@types/hast": "^3.0.4",
     "@types/node": "^22.8.1",
-    "@types/react": "^19.1.9",
+    "@types/react": "^19.1.11",
     "react": "^19.1.1",
     "rsbuild-plugin-publint": "^0.3.3",
     "typescript": "^5.8.2",
@@ -51,7 +50,7 @@
     "@rspress/config": "1.0.0"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.0-beta.27"
+    "@rspress/core": "^2.0.0-beta.29"
   },
   "engines": {
     "node": ">=18.0.0"