@rspress/plugin-api-docgen 2.0.0-beta.0 → 2.0.0-beta.10

package/README.md

@@ -1,3 +1,3 @@
 # @rspress/plugin-api-docgen
 
-The auto api generate plugin for [Rspress](https://rspress.dev).
+The auto api generate plugin for [Rspress](https://rspress.rs).

package/dist/index.js

@@ -1,322 +1,255 @@
-"use strict";
-var __webpack_modules__ = {
-    documentation: function(module) {
-        module.exports = import("documentation").then(function(module) {
-            return module;
-        });
+import * as __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__ from "node:fs";
+import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
+import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__ from "@rspress/shared/logger";
+import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__ from "@rspress/shared";
+import * as __WEBPACK_EXTERNAL_MODULE_chokidar__ from "chokidar";
+import * as __WEBPACK_EXTERNAL_MODULE_react_docgen_typescript_e816f54f__ from "react-docgen-typescript";
+__WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(__dirname, '..');
+const apiDocMap = {};
+const locales = {
+    zh: {
+        copy: "\u590D\u5236",
+        copied: "\u590D\u5236\u6210\u529F",
+        expand: "\u5C55\u5F00\u4EE3\u7801",
+        collapse: "\u6536\u8D77\u4EE3\u7801",
+        className: "\u8282\u70B9\u7C7B\u540D",
+        style: "\u8282\u70B9\u6837\u5F0F",
+        children: "\u5B50\u8282\u70B9",
+        disabled: "\u662F\u5426\u7981\u7528",
+        required: "\u5FC5\u586B",
+        property: "\u5C5E\u6027",
+        description: "\u8BF4\u660E",
+        type: "\u7C7B\u578B",
+        defaultValue: "\u9ED8\u8BA4\u503C",
+        overview: "\u6982\u89C8"
+    },
+    en: {
+        copy: 'Copy',
+        copied: 'Copied Success!',
+        expand: 'Expand Code',
+        collapse: 'Collapse Code',
+        className: 'Additional css class',
+        style: 'Additional style',
+        children: 'Children',
+        disabled: 'Whether to disable ',
+        required: 'Required',
+        property: 'Property',
+        description: "Description",
+        type: 'Type',
+        defaultValue: 'Default Value',
+        overview: 'Overview'
+    },
+    ru: {
+        copy: "\u041A\u043E\u043F\u0438\u0440\u043E\u0432\u0430\u0442\u044C",
+        copied: "\u0421\u043A\u043E\u043F\u0438\u0440\u043E\u0432\u0430\u043D\u043E \u0443\u0441\u043F\u0435\u0448\u043D\u043E",
+        expand: "\u0420\u0430\u0437\u0432\u0435\u0440\u043D\u0443\u0442\u044C \u043A\u043E\u0434",
+        collapse: "\u0421\u0432\u0435\u0440\u043D\u0443\u0442\u044C \u043A\u043E\u0434",
+        className: "\u0418\u043C\u044F \u043A\u043B\u0430\u0441\u0441\u0430 \u0443\u0437\u043B\u0430",
+        style: "\u0421\u0442\u0438\u043B\u044C \u0443\u0437\u043B\u0430",
+        children: "\u0414\u043E\u0447\u0435\u0440\u043D\u0438\u0435 \u044D\u043B\u0435\u043C\u0435\u043D\u0442\u044B",
+        disabled: "\u041E\u0442\u043A\u043B\u044E\u0447\u0435\u043D\u043E",
+        required: "\u041E\u0431\u044F\u0437\u0430\u0442\u0435\u043B\u044C\u043D\u043E",
+        property: "\u0421\u0432\u043E\u0439\u0441\u0442\u0432\u043E",
+        description: "\u041E\u043F\u0438\u0441\u0430\u043D\u0438\u0435",
+        type: "\u0422\u0438\u043F",
+        defaultValue: "\u0417\u043D\u0430\u0447\u0435\u043D\u0438\u0435 \u043F\u043E \u0443\u043C\u043E\u043B\u0447\u0430\u043D\u0438\u044E",
+        overview: "\u041E\u0431\u0437\u043E\u0440"
     }
 };
-var __webpack_module_cache__ = {};
-function __webpack_require__(moduleId) {
-    var cachedModule = __webpack_module_cache__[moduleId];
-    if (void 0 !== cachedModule) return cachedModule.exports;
-    var module = __webpack_module_cache__[moduleId] = {
-        exports: {}
-    };
-    __webpack_modules__[moduleId](module, module.exports, __webpack_require__);
-    return module.exports;
-}
-(()=>{
-    __webpack_require__.n = (module)=>{
-        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
-        __webpack_require__.d(getter, {
-            a: getter
-        });
-        return getter;
-    };
-})();
-(()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
+const isToolEntries = (obj)=>!!obj.documentation || !!obj["react-docgen-typescript"];
+const docgen = async ({ entries, languages, apiParseTool, appDir, parseToolOptions, isProd })=>{
+    const watchFileMap = {};
+    const genApiDoc = async (entry, tool)=>{
+        if (0 === Object.keys(entry).length) return;
+        await Promise.all(Object.entries(entry).map(async ([key, value])=>{
+            const moduleSourceFilePath = __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].resolve(appDir, value);
+            watchFileMap[moduleSourceFilePath] = {
+                apiParseTool,
+                moduleName: key
+            };
+            try {
+                if ('documentation' === tool) {
+                    const documentation = await import("documentation");
+                    const documentationRes = await documentation.build([
+                        moduleSourceFilePath
+                    ], {
+                        ...parseToolOptions.documentation
+                    });
+                    const apiDoc = await documentation.formats.md(documentationRes, {
+                        noReferenceLinks: parseToolOptions.documentation?.noReferenceLinks ?? true
+                    });
+                    apiDocMap[key] = apiDoc;
+                } else {
+                    const { tsconfigPath, compilerOptions, ...restOptions } = parseToolOptions?.["react-docgen-typescript"] ?? {};
+                    const parserOpts = {
+                        propFilter: (prop)=>{
+                            if (void 0 !== prop.declarations && prop.declarations.length > 0) {
+                                const hasPropAdditionalDescription = prop.declarations.find((declaration)=>!declaration.fileName.includes('node_modules'));
+                                return Boolean(hasPropAdditionalDescription);
+                            }
+                            return true;
+                        },
+                        ...restOptions
+                    };
+                    let fileParser = (0, __WEBPACK_EXTERNAL_MODULE_react_docgen_typescript_e816f54f__.withDefaultConfig)(parserOpts);
+                    if (tsconfigPath?.[key]) fileParser = (0, __WEBPACK_EXTERNAL_MODULE_react_docgen_typescript_e816f54f__.withCustomConfig)(tsconfigPath[key], parserOpts);
+                    else if (compilerOptions?.[key]) fileParser = (0, __WEBPACK_EXTERNAL_MODULE_react_docgen_typescript_e816f54f__.withCompilerOptions)(compilerOptions[key], parserOpts);
+                    const componentDoc = fileParser.parse(moduleSourceFilePath);
+                    if (0 === componentDoc.length) __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.warn('[module-doc-plugin]', `Unable to parse API document in ${moduleSourceFilePath}`);
+                    if (languages.length > 0) languages.forEach((language)=>{
+                        apiDocMap[`${key}-${language}`] = generateTable(componentDoc, language);
+                    });
+                    else apiDocMap[key] = generateTable(componentDoc, 'en');
+                }
+            } catch (e) {
+                if (e instanceof Error) __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.error('[module-doc-plugin]', 'Generate API table error:\n', e);
+            }
+        }));
     };
-})();
-(()=>{
-    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
-})();
-(()=>{
-    __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
-            value: 'Module'
-        });
-        Object.defineProperty(exports1, '__esModule', {
-            value: true
+    __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.info('[module-doc-plugin]', 'Start to generate API table...');
+    if (isToolEntries(entries)) {
+        const reactEntries = entries["react-docgen-typescript"];
+        const documentationEntries = entries.documentation;
+        await Promise.all([
+            genApiDoc(reactEntries, "react-docgen-typescript"),
+            genApiDoc(documentationEntries, 'documentation')
+        ]);
+    } else await genApiDoc(entries, apiParseTool);
+    if (!isProd) {
+        const watcher = __WEBPACK_EXTERNAL_MODULE_chokidar__["default"].watch(Object.keys(watchFileMap), {
+            ignoreInitial: true,
+            ignorePermissionErrors: true,
+            ignored: [
+                /node_modules/
+            ]
         });
-    };
-})();
-var __webpack_exports__ = {};
-(()=>{
-    __webpack_require__.r(__webpack_exports__);
-    __webpack_require__.d(__webpack_exports__, {
-        pluginApiDocgen: ()=>pluginApiDocgen
-    });
-    const external_node_fs_namespaceObject = require("node:fs");
-    var external_node_fs_default = /*#__PURE__*/ __webpack_require__.n(external_node_fs_namespaceObject);
-    const external_node_path_namespaceObject = require("node:path");
-    var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
-    const logger_namespaceObject = require("@rspress/shared/logger");
-    external_node_path_default().join(__dirname, '..');
-    const apiDocMap = {};
-    const shared_namespaceObject = require("@rspress/shared");
-    const external_chokidar_namespaceObject = require("chokidar");
-    var external_chokidar_default = /*#__PURE__*/ __webpack_require__.n(external_chokidar_namespaceObject);
-    const external_react_docgen_typescript_namespaceObject = require("react-docgen-typescript");
-    const locales = {
-        zh: {
-            copy: '复制',
-            copied: '复制成功',
-            expand: '展开代码',
-            collapse: '收起代码',
-            className: '节点类名',
-            style: '节点样式',
-            children: '子节点',
-            disabled: '是否禁用',
-            required: '必填',
-            property: '属性',
-            description: '说明',
-            type: '类型',
-            defaultValue: '默认值',
-            overview: '概览'
-        },
-        en: {
-            copy: 'Copy',
-            copied: 'Copied Success!',
-            expand: 'Expand Code',
-            collapse: 'Collapse Code',
-            className: 'Additional css class',
-            style: 'Additional style',
-            children: 'Children',
-            disabled: 'Whether to disable ',
-            required: 'Required',
-            property: 'Property',
-            description: "Description",
-            type: 'Type',
-            defaultValue: 'Default Value',
-            overview: 'Overview'
-        },
-        ru: {
-            copy: 'Копировать',
-            copied: 'Скопировано успешно',
-            expand: 'Развернуть код',
-            collapse: 'Свернуть код',
-            className: 'Имя класса узла',
-            style: 'Стиль узла',
-            children: 'Дочерние элементы',
-            disabled: 'Отключено',
-            required: 'Обязательно',
-            property: 'Свойство',
-            description: 'Описание',
-            type: 'Тип',
-            defaultValue: 'Значение по умолчанию',
-            overview: 'Обзор'
-        }
-    };
-    const isToolEntries = (obj)=>!!obj.documentation || !!obj["react-docgen-typescript"];
-    const docgen = async ({ entries, languages, apiParseTool, appDir, parseToolOptions, isProd })=>{
-        const watchFileMap = {};
-        const genApiDoc = async (entry, tool)=>{
-            if (0 === Object.keys(entry).length) return;
-            await Promise.all(Object.entries(entry).map(async ([key, value])=>{
-                const moduleSourceFilePath = external_node_path_default().resolve(appDir, value);
-                watchFileMap[moduleSourceFilePath] = {
-                    apiParseTool,
-                    moduleName: key
-                };
-                try {
-                    if ('documentation' === tool) {
-                        var _parseToolOptions_documentation;
-                        const documentation = await Promise.resolve().then(__webpack_require__.bind(__webpack_require__, "documentation"));
-                        const documentationRes = await documentation.build([
-                            moduleSourceFilePath
-                        ], {
-                            ...parseToolOptions.documentation
-                        });
-                        const apiDoc = await documentation.formats.md(documentationRes, {
-                            noReferenceLinks: (null == (_parseToolOptions_documentation = parseToolOptions.documentation) ? void 0 : _parseToolOptions_documentation.noReferenceLinks) ?? true
-                        });
-                        apiDocMap[key] = apiDoc;
-                    } else {
-                        const { tsconfigPath, compilerOptions, ...restOptions } = (null == parseToolOptions ? void 0 : parseToolOptions["react-docgen-typescript"]) ?? {};
-                        const parserOpts = {
-                            propFilter: (prop)=>{
-                                if (void 0 !== prop.declarations && prop.declarations.length > 0) {
-                                    const hasPropAdditionalDescription = prop.declarations.find((declaration)=>!declaration.fileName.includes('node_modules'));
-                                    return Boolean(hasPropAdditionalDescription);
-                                }
-                                return true;
-                            },
-                            ...restOptions
+        let isUpdate = false;
+        watcher.on('change', (changed)=>{
+            if (isUpdate) return;
+            isUpdate = true;
+            __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.info('[module-doc-plugin]', 'updating API');
+            const watchFileInfo = watchFileMap[changed];
+            if (watchFileInfo) {
+                const { apiParseTool, moduleName } = watchFileInfo;
+                const updateSiteData = ()=>{
+                    const siteDataPath = __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(process.cwd(), 'node_modules', __WEBPACK_EXTERNAL_MODULE__rspress_shared_baa012d0__.RSPRESS_TEMP_DIR, 'runtime', 'virtual-site-data.mjs');
+                    import(siteDataPath).then((siteData)=>{
+                        const data = {
+                            ...siteData.default
                         };
-                        let fileParser = (0, external_react_docgen_typescript_namespaceObject.withDefaultConfig)(parserOpts);
-                        if (null == tsconfigPath ? void 0 : tsconfigPath[key]) fileParser = (0, external_react_docgen_typescript_namespaceObject.withCustomConfig)(tsconfigPath[key], parserOpts);
-                        else if (null == compilerOptions ? void 0 : compilerOptions[key]) fileParser = (0, external_react_docgen_typescript_namespaceObject.withCompilerOptions)(compilerOptions[key], parserOpts);
-                        const componentDoc = fileParser.parse(moduleSourceFilePath);
-                        if (0 === componentDoc.length) logger_namespaceObject.logger.warn('[module-doc-plugin]', `Unable to parse API document in ${moduleSourceFilePath}`);
-                        if (languages.length > 0) languages.forEach((language)=>{
-                            apiDocMap[`${key}-${language}`] = generateTable(componentDoc, language);
-                        });
-                        else apiDocMap[key] = generateTable(componentDoc, 'en');
-                    }
-                } catch (e) {
-                    if (e instanceof Error) logger_namespaceObject.logger.error('[module-doc-plugin]', 'Generate API table error:\n', e);
-                }
-            }));
-        };
-        logger_namespaceObject.logger.info('[module-doc-plugin]', 'Start to generate API table...');
-        if (isToolEntries(entries)) {
-            const reactEntries = entries["react-docgen-typescript"];
-            const documentationEntries = entries.documentation;
-            await Promise.all([
-                genApiDoc(reactEntries, "react-docgen-typescript"),
-                genApiDoc(documentationEntries, 'documentation')
-            ]);
-        } else await genApiDoc(entries, apiParseTool);
-        if (!isProd) {
-            const watcher = external_chokidar_default().watch(Object.keys(watchFileMap), {
-                ignoreInitial: true,
-                ignorePermissionErrors: true,
-                ignored: [
-                    /node_modules/
-                ]
-            });
-            let isUpdate = false;
-            watcher.on('change', (changed)=>{
-                if (isUpdate) return;
-                isUpdate = true;
-                logger_namespaceObject.logger.info('[module-doc-plugin]', 'updating API');
-                const watchFileInfo = watchFileMap[changed];
-                if (watchFileInfo) {
-                    const { apiParseTool, moduleName } = watchFileInfo;
-                    const updateSiteData = ()=>{
-                        const siteDataPath = external_node_path_default().join(process.cwd(), 'node_modules', shared_namespaceObject.RSPRESS_TEMP_DIR, 'runtime', 'virtual-site-data.mjs');
-                        import(siteDataPath).then((siteData)=>{
-                            const data = {
-                                ...siteData.default
-                            };
-                            data.pages.forEach((page)=>{
-                                page.apiDocMap = apiDocMap;
-                            });
-                            external_node_fs_default().writeFileSync(siteDataPath, `export default ${JSON.stringify(data)}`);
-                            isUpdate = false;
+                        data.pages.forEach((page)=>{
+                            page.apiDocMap = apiDocMap;
                         });
-                    };
-                    genApiDoc({
-                        [moduleName]: changed
-                    }, apiParseTool).then(updateSiteData);
-                }
-            });
-        }
-        logger_namespaceObject.logger.success('[module-doc-plugin]', 'Generate API table successfully!');
-    };
-    function generateTable(componentDoc, language) {
-        return componentDoc.map((param)=>{
-            const { props } = param;
-            const t = locales[language];
-            const PROP_TABLE_HEADER = `|${t.property}|${t.description}|${t.type}|${t.defaultValue}|\n|:---:|:---:|:---:|:---:|`;
-            const tableContent = Object.keys(props).filter((propName)=>{
-                const { name, description } = props[propName];
-                return description || [
-                    'className',
-                    'style',
-                    'disabled',
-                    'children'
-                ].indexOf(name) > -1;
-            }).map((propName)=>{
-                const { defaultValue, description, name, required, type } = props[propName];
-                const getType = ()=>`\`${type.name.replace(/\|/g, '\\|')}\`${required ? ` **(${t.required})**` : ''}`;
-                const getDefaultValue = ()=>`\`${(null == defaultValue ? void 0 : defaultValue.value) || '-'}\``;
-                const getDescription = ()=>{
-                    switch(name){
-                        case 'className':
-                            return description || t.className;
-                        case 'style':
-                            return description || t.style;
-                        case 'children':
-                            return description || t.children;
-                        case 'disabled':
-                            return description || t.disabled;
-                        default:
-                            return description;
-                    }
+                        __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__["default"].writeFileSync(siteDataPath, `export default ${JSON.stringify(data)}`);
+                        isUpdate = false;
+                    });
                 };
-                const formattedDescription = getDescription().replace(/\n/g, '
');
-                return `|${[
-                    name,
-                    formattedDescription,
-                    getType(),
-                    getDefaultValue()
-                ].map((str)=>str.replace(/(?<!\\)\|/g, '&#124;')).join('|')}|`;
-            });
-            return `
+                genApiDoc({
+                    [moduleName]: changed
+                }, apiParseTool).then(updateSiteData);
+            }
+        });
+    }
+    __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.success('[module-doc-plugin]', 'Generate API table successfully!');
+};
+function generateTable(componentDoc, language) {
+    return componentDoc.map((param)=>{
+        const { props } = param;
+        const t = locales[language];
+        const PROP_TABLE_HEADER = `|${t.property}|${t.description}|${t.type}|${t.defaultValue}|\n|:---:|:---:|:---:|:---:|`;
+        const tableContent = Object.keys(props).filter((propName)=>{
+            const { name, description } = props[propName];
+            return description || [
+                'className',
+                'style',
+                'disabled',
+                'children'
+            ].indexOf(name) > -1;
+        }).map((propName)=>{
+            const { defaultValue, description, name, required, type } = props[propName];
+            const getType = ()=>`\`${type.name.replace(/\|/g, '\\|')}\`${required ? ` **(${t.required})**` : ''}`;
+            const getDefaultValue = ()=>`\`${defaultValue?.value || '-'}\``;
+            const getDescription = ()=>{
+                switch(name){
+                    case 'className':
+                        return description || t.className;
+                    case 'style':
+                        return description || t.style;
+                    case 'children':
+                        return description || t.children;
+                    case 'disabled':
+                        return description || t.disabled;
+                    default:
+                        return description;
+                }
+            };
+            const formattedDescription = getDescription().replace(/\n/g, '&#10;');
+            return `|${[
+                name,
+                formattedDescription,
+                getType(),
+                getDefaultValue()
+            ].map((str)=>str.replace(/(?<!\\)\|/g, '&#124;')).join('|')}|`;
+        });
+        return `
   ${param.displayName ? `### ${param.displayName}\n` : ''}
   ${param.description ? `**${param.description}**\n` : ''}
   ${PROP_TABLE_HEADER}
   ${tableContent.join('\n')}
     `;
-        }).join('\n');
-    }
-    function pluginApiDocgen(options) {
-        const { entries = {}, apiParseTool = "react-docgen-typescript", appDir = process.cwd(), parseToolOptions = {} } = options || {};
-        return {
-            name: '@modern-js/doc-plugin-api-docgen',
-            config (config) {
-                config.markdown = config.markdown || {};
-                config.markdown.mdxRs = false;
-                return config;
-            },
-            async beforeBuild (config, isProd) {
-                var _config_themeConfig_locales, _config_themeConfig, _config_locales;
-                const languages = ((null == (_config_themeConfig = config.themeConfig) ? void 0 : null == (_config_themeConfig_locales = _config_themeConfig.locales) ? void 0 : _config_themeConfig_locales.map((locale)=>locale.lang)) || (null == (_config_locales = config.locales) ? void 0 : _config_locales.map((locale)=>locale.lang)) || []).filter((lang)=>[
-                        'zh',
-                        'en',
-                        'ru'
-                    ].includes(lang));
-                await docgen({
-                    entries,
-                    apiParseTool,
-                    languages,
-                    appDir,
-                    parseToolOptions,
-                    isProd
-                });
-            },
-            async modifySearchIndexData (pages) {
-                const apiCompRegExp = /(<API\s+moduleName=['"](\S+)['"]\s*(.*)?\/>)|(<API\s+moduleName=['"](\S+)['"]\s*(.*)?>(.*)?<\/API>)/;
-                await Promise.all(pages.map(async (page)=>{
-                    const { _filepath, lang } = page;
-                    let content = await external_node_fs_default().promises.readFile(_filepath, 'utf-8');
-                    let matchResult = apiCompRegExp.exec(content);
-                    if (!matchResult) return;
-                    while(null !== matchResult){
-                        const matchContent = matchResult[0];
-                        const moduleName = matchResult[2] ?? matchResult[5] ?? '';
-                        const apiDoc = apiDocMap[moduleName] ?? apiDocMap[`${moduleName}-${lang ? lang : 'en'}`] ?? '';
-                        if (matchContent && !apiDoc) logger_namespaceObject.logger.warn(`No api doc found for module: ${moduleName} in lang: ${lang ?? 'en'}`);
-                        content = content.replace(matchContent, apiDoc);
-                        matchResult = apiCompRegExp.exec(content);
-                    }
-                    page.content = content;
-                }));
-            },
-            extendPageData (pageData) {
-                pageData.apiDocMap = {
-                    ...apiDocMap
-                };
-            },
-            markdown: {
-                globalComponents: [
-                    external_node_path_default().join(__dirname, '..', 'static', 'global-components', 'API.tsx')
-                ]
-            }
-        };
-    }
-})();
-exports.pluginApiDocgen = __webpack_exports__.pluginApiDocgen;
-for(var __webpack_i__ in __webpack_exports__)if (-1 === [
-    "pluginApiDocgen"
-].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});
+    }).join('\n');
+}
+function pluginApiDocgen(options) {
+    const { entries = {}, apiParseTool = "react-docgen-typescript", appDir = process.cwd(), parseToolOptions = {} } = options || {};
+    return {
+        name: '@modern-js/doc-plugin-api-docgen',
+        config (config) {
+            config.markdown = config.markdown || {};
+            return config;
+        },
+        async beforeBuild (config, isProd) {
+            const languages = (config.themeConfig?.locales?.map((locale)=>locale.lang) || config.locales?.map((locale)=>locale.lang) || []).filter((lang)=>[
+                    'zh',
+                    'en',
+                    'ru'
+                ].includes(lang));
+            await docgen({
+                entries,
+                apiParseTool,
+                languages,
+                appDir,
+                parseToolOptions,
+                isProd
+            });
+        },
+        async modifySearchIndexData (pages) {
+            const apiCompRegExp = /(<API\s+moduleName=['"](\S+)['"]\s*(.*)?\/>)|(<API\s+moduleName=['"](\S+)['"]\s*(.*)?>(.*)?<\/API>)/;
+            await Promise.all(pages.map(async (page)=>{
+                const { _filepath, lang } = page;
+                let content = await __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__["default"].promises.readFile(_filepath, 'utf-8');
+                let matchResult = apiCompRegExp.exec(content);
+                if (!matchResult) return;
+                while(null !== matchResult){
+                    const matchContent = matchResult[0];
+                    const moduleName = matchResult[2] ?? matchResult[5] ?? '';
+                    const apiDoc = apiDocMap[moduleName] ?? apiDocMap[`${moduleName}-${lang ? lang : 'en'}`] ?? '';
+                    if (matchContent && !apiDoc) __WEBPACK_EXTERNAL_MODULE__rspress_shared_logger_4374e44a__.logger.warn(`No api doc found for module: ${moduleName} in lang: ${lang ?? 'en'}`);
+                    content = content.replace(matchContent, apiDoc);
+                    matchResult = apiCompRegExp.exec(content);
+                }
+                page.content = content;
+            }));
+        },
+        extendPageData (pageData) {
+            pageData.apiDocMap = {
+                ...apiDocMap
+            };
+        },
+        markdown: {
+            globalComponents: [
+                __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].join(__dirname, '..', 'static', 'global-components', 'API.tsx')
+            ]
+        }
+    };
+}
+export { pluginApiDocgen };

package/package.json

@@ -1,48 +1,54 @@
 {
   "name": "@rspress/plugin-api-docgen",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.10",
   "description": "A plugin for rspress to generate api doc.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rspress",
+    "url": "git+https://github.com/web-infra-dev/rspress.git",
     "directory": "packages/plugin-api-docgen"
   },
   "license": "MIT",
-  "main": "./dist/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "types": "./index.d.ts",
   "files": [
     "dist",
     "static",
-    "index.d.ts",
-    "mdx-meta-loader.cjs"
+    "index.d.ts"
   ],
   "dependencies": {
     "chokidar": "^3.6.0",
     "documentation": "14.0.3",
+    "github-slugger": "^2.0.0",
     "react-docgen-typescript": "2.2.2",
     "react-markdown": "^10.1.0",
     "remark-gfm": "^4.0.1",
-    "@rspress/shared": "2.0.0-beta.0"
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.0.0",
+    "@rspress/shared": "2.0.0-beta.10"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.4",
-    "@rslib/core": "0.6.5",
+    "@microsoft/api-extractor": "^7.52.8",
+    "@rslib/core": "0.8.0",
+    "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^18.11.17",
-    "@types/react": "^18.3.20",
-    "@types/react-dom": "^18.3.6",
+    "@types/node": "^22.8.1",
+    "@types/react": "^18.3.22",
+    "@types/react-dom": "^18.3.7",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "react-router-dom": "^6.29.0",
-    "typescript": "^5.8.2",
-    "unified": "^11.0.5",
-    "unist-util-visit": "^5.0.0"
+    "rsbuild-plugin-publint": "^0.3.2",
+    "typescript": "^5.8.2"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.0-beta.0",
-    "react": ">=17.0.0",
-    "react-router-dom": "^6.8.1",
+    "@rspress/core": "^2.0.0-beta.10",
     "typescript": "^5.8.2"
   },
   "peerDependenciesMeta": {
@@ -51,7 +57,7 @@
     }
   },
   "engines": {
-    "node": ">=14.17.6"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public",

package/static/global-components/API.tsx

@@ -5,6 +5,97 @@ import { getCustomMDXComponent } from '@rspress/core/theme';
 import ReactMarkdown from 'react-markdown';
 import remarkGfm from 'remark-gfm';
 import './API.css';
+import GithubSlugger from 'github-slugger';
+import type { Content, Element, Root } from 'hast';
+// biome-ignore lint/style/useImportType: <exact>
+import React from 'react';
+import type { Plugin } from 'unified';
+import { visit } from 'unist-util-visit';
+
+function headingRank(node: Root | Content): number | null {
+  const name =
+    (node && node.type === 'element' && node.tagName.toLowerCase()) || '';
+  const code =
+    name.length === 2 && name.charCodeAt(0) === 104 /* `h` */
+      ? name.charCodeAt(1)
+      : 0;
+  return code > 48 /* `0` */ && code < 55 /* `7` */
+    ? code - 48 /* `0` */
+    : null;
+}
+
+const rehypeHeaderAnchor: Plugin<[], Root> = () => {
+  const slugger = new GithubSlugger();
+  return tree => {
+    visit(tree, 'element', node => {
+      if (!headingRank(node)) {
+        return;
+      }
+      // generate id
+
+      if (!node.properties?.id) {
+        const text = collectHeaderText(node);
+        node.properties ??= {};
+        node.properties.id = slugger.slug(text);
+      }
+      // apply to headings
+      node.children.unshift(create(node));
+    });
+  };
+};
+
+/**
+ * Create an `a`.
+ *
+ * @param {Readonly<Element>} node
+ *   Related heading.
+ * @returns {Element}
+ *   Link.
+ */
+function create(node: Element): Element {
+  return {
+    type: 'element',
+    tagName: 'a',
+    properties: {
+      class: 'header-anchor',
+      ariaHidden: 'true',
+      href: `#${node.properties!.id}`,
+    },
+    children: [
+      {
+        type: 'text',
+        value: '#',
+      },
+    ],
+  };
+}
+
+const extractTextAndId = (title?: string): string => {
+  if (!title) {
+    return '';
+  }
+  const text = title.trimEnd();
+  return text;
+};
+
+const collectHeaderText = (node: Element): string => {
+  let text = '';
+  node.children.forEach(child => {
+    if (child.type === 'text') {
+      const textPart = extractTextAndId(child.value);
+      child.value = textPart;
+      text += textPart;
+    }
+    if (child.type === 'element') {
+      child.children.forEach(c => {
+        if (c.type === 'text') {
+          text += c.value;
+        }
+      });
+    }
+  });
+  return text;
+};
 
 export default (props: { moduleName: string }) => {
   const lang = useLang();
@@ -19,6 +110,7 @@ export default (props: { moduleName: string }) => {
     <div className="rspress-plugin-api-docgen">
       <ReactMarkdown
         remarkPlugins={[[remarkGfm]]}
+        rehypePlugins={[[rehypeHeaderAnchor]]}
         components={
           getCustomMDXComponent() as Record<string, React.ElementType>
         }

package/mdx-meta-loader.cjs

@@ -1,26 +0,0 @@
-const { demoMeta } = require('./dist');
-
-module.exports = async function () {
-  const callback = this.async();
-  const demos = demoMeta[this.resourcePath] || [];
-  try {
-    const result = `
-      ${demos
-        .map((item) => {
-          return `import Demo_${item.id} from '${item.virtualModulePath}';`;
-        })
-        .join('\n')}
-      export default [${demos
-        .map((item) => {
-          return `{
-            "id": "${item.id}",
-            "component": Demo_${item.id}
-          }`;
-        })
-        .join(',')}];
-    `;
-    callback(null, result);
-  } catch (err) {
-    callback(err);
-  }
-};