@rspress/plugin-llms 2.0.0-beta.17 → 2.0.0-beta.19

package/dist/index.d.ts

@@ -1,7 +1,18 @@
 import type { PageIndexInfo } from '@rspress/shared';
 import type { RspressPlugin } from '@rspress/shared';
 
+declare interface LlmsFullTxt {
+    /**
+     * @default "llms-full.txt"
+     */
+    name: string;
+}
+
 export declare interface LlmsTxt {
+    /**
+     * @default "llms.txt"
+     */
+    name: string;
     onTitleGenerate?: (context: {
         title: string | undefined;
         description: string | undefined;
@@ -10,22 +21,26 @@ export declare interface LlmsTxt {
     onAfterLlmsTxtGenerate?: (llmsTxtContent: string) => string;
 }
 
+declare interface MdFiles {
+    /**
+     * @default true
+     */
+    mdxToMd: boolean;
+}
+
 export declare interface Options {
     /**
      * Whether to generate llms.txt.
-     * @default true
      */
-    llmsTxt?: boolean | LlmsTxt;
+    llmsTxt?: false | LlmsTxt;
     /**
      * Whether to generate llms.txt related md files for each route.
-     * @default true
      */
-    mdFiles?: boolean;
+    mdFiles?: false | MdFiles;
     /**
      * Whether to generate llms-full.txt.
-     * @default true
      */
-    llmsFullTxt?: boolean;
+    llmsFullTxt?: false | LlmsFullTxt;
     /**
      * Whether to include some routes from llms.txt.
      * @param context
@@ -47,6 +62,8 @@ export declare interface Options {
 /**
  * A plugin for rspress to generate llms.txt, llms-full.txt, md files to let llm understand your website.
  */
-export declare function pluginLlms(options?: Options): RspressPlugin;
+export declare function pluginLlms(options?: RspressPluginLlmsOptions): RspressPlugin;
+
+declare type RspressPluginLlmsOptions = Options | Options[];
 
 export { }

package/dist/index.js

@@ -1,6 +1,6 @@
 /*! For license information please see index.js.LICENSE.txt */
 import node_path from "node:path";
-import { getSidebarDataGroup, normalizeHref, removeBase } from "@rspress/shared";
+import { getSidebarDataGroup, normalizeHref, withBase } from "@rspress/shared";
 import { logger } from "@rspress/shared/logger";
 import { remarkPluginNormalizeLink } from "@rspress/core";
 import remark_mdx from "remark-mdx";
@@ -116,15 +116,15 @@ new Set([
     308
 ]);
 Symbol("deferred");
-function routePathToMdPath(routePath) {
+function routePathToMdPath(routePath, base) {
     let url = routePath;
     url = normalizeHref(url, false);
     url = url.replace(/\.html$/, '.md');
-    return url;
+    return withBase(url, base);
 }
-function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title, description) {
+function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title, description, base) {
     const lines = [];
-    const { onAfterLlmsTxtGenerate, onLineGenerate, onTitleGenerate } = 'boolean' == typeof llmsTxtOptions ? {} : llmsTxtOptions;
+    const { onAfterLlmsTxtGenerate, onLineGenerate, onTitleGenerate } = llmsTxtOptions;
     const summary = onTitleGenerate ? onTitleGenerate({
         title,
         description
@@ -139,7 +139,7 @@ function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title,
         for (const page of pages){
             const { routePath, lang, title, frontmatter } = page;
             if ('/' === routePath || routePath === `/${lang}/`) continue;
-            const line = onLineGenerate ? onLineGenerate(page) : `- [${title}](${routePathToMdPath(routePath)})${frontmatter.description ? `: ${frontmatter.description}` : ''}`;
+            const line = onLineGenerate ? onLineGenerate(page) : `- [${title}](${routePathToMdPath(routePath, base)})${frontmatter.description ? `: ${frontmatter.description}` : ''}`;
             lines.push(line);
         }
     }
@@ -149,7 +149,7 @@ function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title,
     for (const page of others){
         const { routePath, lang, title, frontmatter } = page;
         if ('/' === routePath || routePath === `/${lang}/`) continue;
-        const line = onLineGenerate ? onLineGenerate(page) : `- [${title}](${routePathToMdPath(routePath)})${frontmatter.description ? `: ${frontmatter.description}` : ''}`;
+        const line = onLineGenerate ? onLineGenerate(page) : `- [${title}](${routePathToMdPath(routePath, base)})${frontmatter.description ? `: ${frontmatter.description}` : ''}`;
         otherLines.push(line);
         hasOthers = true;
     }
@@ -157,13 +157,13 @@ function generateLlmsTxt(pageDataArray, navList, others, llmsTxtOptions, title,
     const llmsTxt = `${summary}\n${lines.join('\n')}`;
     return onAfterLlmsTxtGenerate ? onAfterLlmsTxtGenerate(llmsTxt) : llmsTxt;
 }
-function generateLlmsFullTxt(pageDataArray, navList, others) {
+function generateLlmsFullTxt(pageDataArray, navList, others, base) {
     const lines = [];
     for(let i = 0; i < navList.length; i++){
         const pages = pageDataArray[i];
         if (0 !== pages.length) for (const page of pages){
             lines.push(`---
-url: ${routePathToMdPath(page.routePath)}
+url: ${routePathToMdPath(page.routePath, base)}
 ---
 `);
             lines.push(page.mdContent ?? page._flattenContent ?? page.content);
@@ -172,7 +172,7 @@ url: ${routePathToMdPath(page.routePath)}
     }
     for (const page of others){
         lines.push(`---
-url: ${routePathToMdPath(page.routePath)}
+url: ${routePathToMdPath(page.routePath, base)}
 ---
 `);
         lines.push(page.mdContent ?? page._flattenContent ?? page.content);
@@ -200,23 +200,27 @@ const mdxToMdPlugin = ()=>(tree)=>{
             }
         });
     };
-function mdxToMd(content, filepath, docDirectory, routeService) {
+function mdxToMd(content, filepath, routeService, base) {
     return unified().use(remark_parse).use(remark_mdx).use(mdxToMdPlugin).use(remarkPluginNormalizeLink, {
         cleanUrls: '.md',
-        root: docDirectory,
-        routeService
+        routeService,
+        __base: base
     }).use(remark_stringify).process({
         value: content,
         path: filepath
     });
 }
-const rsbuildPluginLlms = ({ disableSSGRef, pageDataList, routes, titleRef, descriptionRef, langRef, sidebar, baseRef, docDirectoryRef, routeServiceRef, nav, rspressPluginOptions })=>({
-        name: 'rsbuild-plugin-llms',
+const rsbuildPluginLlms = ({ disableSSGRef, baseRef, pageDataList, routes, titleRef, descriptionRef, langRef, sidebar, routeServiceRef, nav, rspressPluginOptions, index = 0 })=>({
+        name: `rsbuild-plugin-llms-${index}`,
         async setup (api) {
-            const { llmsTxt = true, mdFiles = true, llmsFullTxt = true, include, exclude } = rspressPluginOptions;
+            const { llmsTxt = {
+                name: 'llms.txt'
+            }, mdFiles = {
+                mdxToMd: true
+            }, llmsFullTxt = {
+                name: 'llms-full.txt'
+            }, include, exclude } = rspressPluginOptions;
             api.onBeforeBuild(async ()=>{
-                const base = baseRef.current;
-                const docDirectory = docDirectoryRef.current;
                 const disableSSG = disableSSGRef.current;
                 const newPageDataList = mergeRouteMetaWithPageData(routes, pageDataList, langRef.current, include, exclude);
                 const navList = Array.isArray(nav) ? nav.map((i)=>{
@@ -234,13 +238,14 @@ const rsbuildPluginLlms = ({ disableSSGRef, pageDataList, routes, titleRef, desc
                     for(let i = 0; i < pageArray.length; i++){
                         const pageArrayItem = pageArray[i];
                         const navItem = navList[i];
-                        if (lang === navItem.lang && new RegExp(navItem.activeMatch ?? navItem.link).test(removeBase(routePath, base))) return void pageArrayItem.push(pageData);
+                        if (lang === navItem.lang && new RegExp(navItem.activeMatch ?? navItem.link).test(routePath)) return void pageArrayItem.push(pageData);
                     }
                     others.push(pageData);
                 });
-                for (const array of pageArray)organizeBySidebar(sidebar, array, base);
+                for (const array of pageArray)organizeBySidebar(sidebar, array);
                 if (llmsTxt) {
-                    const llmsTxtContent = generateLlmsTxt(pageArray, navList, others, rspressPluginOptions.llmsTxt ?? {}, titleRef.current, descriptionRef.current);
+                    const { name } = llmsTxt;
+                    const llmsTxtContent = generateLlmsTxt(pageArray, navList, others, llmsTxt, titleRef.current, descriptionRef.current, baseRef.current);
                     api.processAssets({
                         targets: disableSSG ? [
                             'web'
@@ -250,7 +255,7 @@ const rsbuildPluginLlms = ({ disableSSGRef, pageDataList, routes, titleRef, desc
                         stage: 'additional'
                     }, async ({ compilation, sources })=>{
                         const source = new sources.RawSource(llmsTxtContent);
-                        compilation.emitAsset('llms.txt', source);
+                        compilation.emitAsset(name, source);
                     });
                 }
                 const mdContents = {};
@@ -261,9 +266,9 @@ const rsbuildPluginLlms = ({ disableSSGRef, pageDataList, routes, titleRef, desc
                     const filepath = pageData._filepath;
                     const isMD = 'mdx' !== node_path.extname(filepath).slice(1);
                     let mdContent;
-                    if (isMD) mdContent = content;
+                    if (isMD || mdFiles && false === mdFiles.mdxToMd) mdContent = content;
                     else try {
-                        mdContent = (await mdxToMd(content, filepath, docDirectory, routeServiceRef.current)).toString();
+                        mdContent = (await mdxToMd(content, filepath, routeServiceRef.current, baseRef.current)).toString();
                     } catch (e) {
                         logger.debug(e);
                         mdContent = content;
@@ -287,7 +292,8 @@ const rsbuildPluginLlms = ({ disableSSGRef, pageDataList, routes, titleRef, desc
                     });
                 });
                 if (llmsFullTxt) {
-                    const llmsFullTxtContent = generateLlmsFullTxt(pageArray, navList, others);
+                    const { name } = llmsFullTxt;
+                    const llmsFullTxtContent = generateLlmsFullTxt(pageArray, navList, others, baseRef.current);
                     api.processAssets({
                         targets: disableSSG ? [
                             'web'
@@ -297,7 +303,7 @@ const rsbuildPluginLlms = ({ disableSSGRef, pageDataList, routes, titleRef, desc
                         stage: 'additional'
                     }, async ({ compilation, sources })=>{
                         const source = new sources.RawSource(llmsFullTxtContent);
-                        compilation.emitAsset('llms-full.txt', source);
+                        compilation.emitAsset(name, source);
                     });
                 }
             });
@@ -337,10 +343,10 @@ function flatSidebar(sidebar) {
         if ('items' in i && Array.isArray(i.items)) return flatSidebar(i.items);
     }).filter(Boolean);
 }
-function organizeBySidebar(sidebar, pages, base) {
+function organizeBySidebar(sidebar, pages) {
     if (0 === pages.length) return;
     const pageItem = pages[0];
-    const currSidebar = getSidebarDataGroup(sidebar, pageItem.routePath, base);
+    const currSidebar = getSidebarDataGroup(sidebar, pageItem.routePath);
     if (0 === currSidebar.length) return;
     const orderList = flatSidebar(currSidebar);
     pages.sort((a, b)=>{
@@ -416,15 +422,26 @@ function pluginLlms(options = {}) {
         },
         builderConfig: {
             plugins: [
-                rsbuildPluginLlms({
-                    ...options,
+                Array.isArray(options) ? options.map((item, index)=>rsbuildPluginLlms({
+                        pageDataList,
+                        routes,
+                        titleRef,
+                        descriptionRef,
+                        langRef,
+                        sidebar,
+                        routeServiceRef,
+                        nav,
+                        baseRef,
+                        disableSSGRef,
+                        rspressPluginOptions: item,
+                        index
+                    })) : rsbuildPluginLlms({
                     pageDataList,
                     routes,
                     titleRef,
                     descriptionRef,
                     langRef,
                     sidebar,
-                    docDirectoryRef,
                     routeServiceRef,
                     nav,
                     baseRef,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-llms",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.19",
   "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": {
@@ -24,21 +24,21 @@
     "unified": "^11.0.5",
     "unist-util-visit": "^5.0.0",
     "unist-util-visit-children": "^3.0.0",
-    "@rspress/shared": "2.0.0-beta.17"
+    "@rspress/shared": "2.0.0-beta.19"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.52.8",
-    "@rsbuild/core": "~1.4.0-rc.0",
-    "@rslib/core": "0.10.2",
+    "@rsbuild/core": "~1.4.2",
+    "@rslib/core": "0.10.4",
     "@types/hast": "^3.0.4",
     "@types/node": "^22.8.1",
     "typescript": "^5.8.2",
     "vfile": "^6.0.3",
-    "@rspress/runtime": "2.0.0-beta.17",
-    "@rspress/config": "1.0.0"
+    "@rspress/config": "1.0.0",
+    "@rspress/runtime": "2.0.0-beta.19"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.0-beta.17"
+    "@rspress/core": "^2.0.0-beta.19"
   },
   "engines": {
     "node": ">=18.0.0"