@modern-js/module-tools-docs 2.32.2-alpha.1 → 2.33.0

package/.eslintrc.js

@@ -5,7 +5,7 @@ module.exports = {
     tsconfigRootDir: __dirname,
     project: ['./tsconfig.json'],
   },
-  ignorePatterns: ['modern.config.ts'],
+  ignorePatterns: ['rspress.config.ts'],
   rules: {
     'babel/no-unused-expressions': 0,
     'react/jsx-filename-extension': 0,

package/CHANGELOG.md

@@ -1,15 +1,15 @@
 # @modern-js/module-tools-docs
 
-## 2.32.2-alpha.0
+## 2.33.0
 
 ### Patch Changes
 
-- bc1f8daf0ff: feat(builder): support custom logger in dev server
+- bc1f8da: feat(builder): support custom logger in dev server
 
   feat(builder): 支持自定义 logger
 
-  - @modern-js/doc-plugin-auto-sidebar@2.32.2-alpha.0
-  - @modern-js/doc-tools@2.32.2-alpha.0
+- Updated dependencies [db9a700]
+  - @modern-js/doc-plugin-auto-sidebar@2.33.0
 
 ## 2.32.1
 

package/package.json

@@ -9,17 +9,18 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.32.2-alpha.1",
+  "version": "2.33.0",
   "main": "index.js",
   "dependencies": {
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "@modern-js/doc-plugin-auto-sidebar": "2.32.2-alpha.1",
-    "@modern-js/doc-tools": "2.32.2-alpha.1"
+    "rspress": "0.0.6",
+    "@rspress/shared": "0.0.6",
+    "@modern-js/doc-plugin-auto-sidebar": "2.33.0"
   },
   "scripts": {
-    "dev": "modern dev",
-    "build:doc": "modern build",
-    "preview": "modern preview"
+    "dev": "rspress dev",
+    "build:doc": "rspress build",
+    "preview": "rspress preview"
   }
 }

package/rspress.config.ts

@@ -0,0 +1,130 @@
+import path from 'path';
+import { NavItem } from '@rspress/shared';
+import { defineConfig } from 'rspress/config';
+import { pluginAutoSidebar } from '@modern-js/doc-plugin-auto-sidebar';
+
+const { version } = require('./package.json');
+
+function getI18nHelper(lang: 'zh' | 'en') {
+  const cn = lang === 'zh';
+  const prefix = cn ? '' : '/en';
+  const getLink = (str: string) => `${prefix}${str}`;
+  const getText = (cnText: string, enText: string) => (cn ? cnText : enText);
+  return { getText, getLink };
+}
+
+function getNavbar(lang: 'zh' | 'en'): NavItem[] {
+  const { getLink, getText } = getI18nHelper(lang);
+
+  return [
+    {
+      text: getText('指南', 'Guide'),
+      link: getLink('/guide/intro/welcome'),
+      activeMatch: '^/guide/',
+    },
+    {
+      text: getText('API', 'API'),
+      link: getLink('/api/'),
+      activeMatch: '^/api/',
+    },
+    {
+      text: getText('插件', 'Plugins'),
+      link: getLink('/plugins/guide/getting-started'),
+      activeMatch: '^/plugins/',
+    },
+    {
+      text: `v${version}`,
+      items: [
+        {
+          text: getText('更新日志', 'Changelog'),
+          link: 'https://github.com/web-infra-dev/modern.js/tree/main/packages/solutions/module-tools/CHANGELOG.md',
+        },
+        {
+          text: getText('贡献指南', 'Contributing'),
+          link: 'https://modernjs.dev/en/community/contributing-guide.html',
+        },
+      ],
+    },
+  ];
+}
+
+export default defineConfig({
+  root: path.join(__dirname, 'docs'),
+  lang: 'zh',
+  base: '/module-tools/',
+  title: 'Module Tools',
+  icon: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/logo-1x-0104.png',
+  // The plugins for doc tools.
+  plugins: [
+    pluginAutoSidebar({
+      root: path.join(__dirname, 'docs'),
+      categories: ['zh', 'en']
+        .map(lang =>
+          ['guide', 'api', 'plugins'].map(category => `${lang}/${category}`),
+        )
+        .flat(),
+      collapsed: false,
+    }),
+  ],
+  markdown: {
+    checkDeadLinks: true,
+    experimentalMdxRs: true,
+  },
+  themeConfig: {
+    footer: {
+      message: 'Copyright © 2023 ByteDance.',
+    },
+    socialLinks: [
+      {
+        icon: 'github',
+        mode: 'link',
+        content:
+          'https://github.com/web-infra-dev/modern.js/tree/main/packages/solutions/module-tools',
+      },
+    ],
+    locales: [
+      {
+        lang: 'zh',
+        label: '简体中文',
+        nav: getNavbar('zh'),
+        title: 'Module Tools',
+        outlineTitle: '目录',
+        prevPageText: '上一页',
+        nextPageText: '下一页',
+        description: '模块工程解决方案',
+      },
+      {
+        lang: 'en',
+        label: 'English',
+        nav: getNavbar('en'),
+        title: 'Module Tools',
+        description: 'Module Engineering Solutions',
+      },
+    ],
+    editLink: {
+      docRepoBaseUrl:
+        'https://github.com/web-infra-dev/modern.js/tree/main/packages/document/module-doc/docs',
+      text: 'Edit this page on GitHub',
+    },
+  },
+  replaceRules: [
+    {
+      // The major version is different inside the ByteDance,
+      // so we use a flag to define it.
+      search: /MAJOR_VERSION/g,
+      replace: '2',
+    },
+  ],
+  builderConfig: {
+    dev: {
+      startUrl: 'http://localhost:<port>/module-tools/',
+    },
+    source: {
+      alias: {
+        '@site-docs': path.join(__dirname, './docs/zh'),
+        '@site-docs-en': path.join(__dirname, './docs/en'),
+        '@site': require('path').resolve(__dirname),
+      },
+    },
+  },
+});

package/theme/index.ts

@@ -1,2 +1,3 @@
-export * from '@modern-js/doc-tools/theme';
-export { default } from '@modern-js/doc-tools/theme';
+// eslint-disable-next-line import/export
+export * from 'rspress/theme';
+export { default } from 'rspress/theme';

package/tsconfig.json

@@ -3,5 +3,5 @@
   "compilerOptions": {
     "jsx": "preserve"
   },
-  "include": ["./theme", "./modern.config.ts"]
+  "include": ["./theme", "./rspress.config.ts"]
 }

package/modern.config.ts

@@ -1,132 +0,0 @@
-import path from 'path';
-import { docTools, defineConfig, NavItem } from '@modern-js/doc-tools';
-import { pluginAutoSidebar } from '@modern-js/doc-plugin-auto-sidebar';
-
-const { version } = require('./package.json');
-
-function getI18nHelper(lang: 'zh' | 'en') {
-  const cn = lang === 'zh';
-  const prefix = cn ? '' : '/en';
-  const getLink = (str: string) => `${prefix}${str}`;
-  const getText = (cnText: string, enText: string) => (cn ? cnText : enText);
-  return { getText, getLink };
-}
-
-function getNavbar(lang: 'zh' | 'en'): NavItem[] {
-  const { getLink, getText } = getI18nHelper(lang);
-
-  return [
-    {
-      text: getText('指南', 'Guide'),
-      link: getLink('/guide/intro/welcome'),
-      activeMatch: '^/guide/',
-    },
-    {
-      text: getText('API', 'API'),
-      link: getLink('/api/'),
-      activeMatch: '^/api/',
-    },
-    {
-      text: getText('插件', 'Plugins'),
-      link: getLink('/plugins/guide/getting-started'),
-      activeMatch: '^/plugins/',
-    },
-    {
-      text: `v${version}`,
-      items: [
-        {
-          text: getText('更新日志', 'Changelog'),
-          link: 'https://github.com/web-infra-dev/modern.js/tree/main/packages/solutions/module-tools/CHANGELOG.md',
-        },
-        {
-          text: getText('贡献指南', 'Contributing'),
-          link: 'https://modernjs.dev/en/community/contributing-guide.html',
-        },
-      ],
-    },
-  ];
-}
-
-export default defineConfig({
-  plugins: [docTools()],
-  doc: {
-    root: path.join(__dirname, 'docs'),
-    lang: 'zh',
-    base: '/module-tools/',
-    title: 'Module Tools',
-    icon: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/logo-1x-0104.png',
-    // The plugins for doc tools.
-    plugins: [
-      pluginAutoSidebar({
-        root: path.join(__dirname, 'docs'),
-        categories: ['zh', 'en']
-          .map(lang =>
-            ['guide', 'api', 'plugins'].map(category => `${lang}/${category}`),
-          )
-          .flat(),
-        collapsed: false,
-      }),
-    ],
-    markdown: {
-      checkDeadLinks: true,
-      experimentalMdxRs: true,
-    },
-    themeConfig: {
-      footer: {
-        message: 'Copyright © 2023 ByteDance.',
-      },
-      socialLinks: [
-        {
-          icon: 'github',
-          mode: 'link',
-          content:
-            'https://github.com/web-infra-dev/modern.js/tree/main/packages/solutions/module-tools',
-        },
-      ],
-      locales: [
-        {
-          lang: 'zh',
-          label: '简体中文',
-          nav: getNavbar('zh'),
-          title: 'Module Tools',
-          outlineTitle: '目录',
-          prevPageText: '上一页',
-          nextPageText: '下一页',
-          description: '模块工程解决方案',
-        },
-        {
-          lang: 'en',
-          label: 'English',
-          nav: getNavbar('en'),
-          title: 'Module Tools',
-          description: 'Module Engineering Solutions',
-        },
-      ],
-      editLink: {
-        docRepoBaseUrl:
-          'https://github.com/web-infra-dev/modern.js/tree/main/packages/document/module-doc/docs',
-        text: 'Edit this page on GitHub',
-      },
-    },
-    replaceRules: [
-      {
-        // The major version is different inside the ByteDance,
-        // so we use a flag to define it.
-        search: /MAJOR_VERSION/g,
-        replace: '2',
-      },
-    ],
-    builderConfig: {
-      dev: {
-        startUrl: 'http://localhost:<port>/module-tools/',
-      },
-      source: {
-        alias: {
-          '@site-docs': path.join(__dirname, './docs/zh'),
-          '@site-docs-en': path.join(__dirname, './docs/en'),
-          '@site': require('path').resolve(__dirname),
-        },
-      }
-    },
-  },
-});