@umijs/plugin-docs 4.0.46 → 4.0.48

package/client/theme-doc/NavBar.tsx

@@ -1,5 +1,5 @@
 import React, { useState } from 'react';
-import { useThemeContext } from './context';
+import { useThemeContext, type INav, type INavDropdown } from './context';
 import ExternalLink from './icons/link.svg';
 import useLanguage from './useLanguage';
 
@@ -14,25 +14,17 @@ export default () => {
   );
 };
 
-interface NavItemProps {
-  nav: {
-    path: string;
-    title: string;
-    type?: 'nav' | 'link';
-    dropdown?: {
-      title: string;
-      path: string;
-    }[];
-  };
+interface INavItemProps {
+  nav: INav;
 }
 
-function NavItem(props: NavItemProps) {
+function NavItem(props: INavItemProps) {
   const { components } = useThemeContext()!;
   const { nav } = props;
   const lang = useLanguage();
   const [isExpanded, setExpanded] = useState(false);
 
-  const isExternalLink = (n: NavItemProps['nav']) => {
+  const isExternalLink = (n: INavDropdown) => {
     return (
       n.type === 'link' && /(https|http):\/\/([\w.]+\/?)\S*/.test(nav.path)
     );
@@ -54,7 +46,11 @@ function NavItem(props: NavItemProps) {
       ) : (
         <components.Link
           to={
-            lang.isFromPath ? lang.currentLanguage?.locale + nav.path : nav.path
+            nav.link
+              ? nav.link
+              : lang.isFromPath
+              ? lang.currentLanguage?.locale + nav.path
+              : nav.path
           }
         >
           {lang.render(nav.title)}

package/client/theme-doc/context.ts

@@ -1,37 +1,51 @@
 import React from 'react';
 
-interface IContext {
-  appData: any;
-  components: any;
-  themeConfig: {
+export interface INavBaseProps {
+  path: string;
+  title: string;
+  type?: 'nav' | 'link';
+}
+
+export interface INavDropdown extends INavBaseProps {}
+
+export interface INav extends INavBaseProps {
+  /**
+   * 不使用 navigate 重定向，而是直接用 link 指定最终地址，否则会破坏 history 历史，导致无法返回
+   * https://github.com/umijs/umi/issues/10325
+   */
+  link: string;
+  dropdown?: INavDropdown[];
+  children: any[];
+}
+
+export interface IThemeConfig {
+  title: string;
+  description?: string;
+  github: string;
+  // 键盘搜索的快捷键，参考 https://github.com/madrobby/keymaster
+  searchHotKey?: string | { macos: string; windows: string };
+  logo: string | React.ComponentType;
+  // 在设置文件中声明该项目的国际化功能支持的语言
+  i18n?: { locale: string; text: string }[];
+  // 插件会从 docs/locales 内将所有 json 文件注入到 themeConfig 中
+  // 供 useLanguage 使用
+  locales: { [locale: string]: { [key: string]: string } };
+  // 顶部导航栏右侧自定义组件
+  extraNavRight?: React.ComponentType;
+  // 底部导航栏左侧自定义组件
+  extraNavLeft?: React.ComponentType;
+  navs: INav[];
+  announcement?: {
     title: string;
-    description?: string;
-    github: string;
-    // 键盘搜索的快捷键，参考 https://github.com/madrobby/keymaster
-    searchHotKey?: string | { macos: string; windows: string };
-    logo: string | React.ComponentType;
-    // 在设置文件中声明该项目的国际化功能支持的语言
-    i18n?: { locale: string; text: string }[];
-    // 插件会从 docs/locales 内将所有 json 文件注入到 themeConfig 中
-    // 供 useLanguage 使用
-    locales: { [locale: string]: { [key: string]: string } };
-    // 顶部导航栏右侧自定义组件
-    extraNavRight?: React.ComponentType;
-    // 底部导航栏左侧自定义组件
-    extraNavLeft?: React.ComponentType;
-    navs: {
-      path: string;
-      title: string;
-      type: 'nav' | 'link';
-      dropdown?: { title: string; path: string }[];
-      children: any[];
-    }[];
-    announcement?: {
-      title: string;
-      link?: string;
-    };
-    themeSwitch?: {};
+    link?: string;
   };
+  themeSwitch?: {};
+}
+
+export interface IContext {
+  appData: any;
+  components: any;
+  themeConfig: IThemeConfig;
   location: {
     pathname: string;
     search: string;

package/dist/compiler.js

@@ -16,7 +16,10 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/compiler.ts
@@ -57,14 +60,16 @@ async function compile(opts) {
   });
   try {
     let result = String(await compiler.process(opts.content));
-    result = result.replace("function MDXContent(props = {}) {", `
+    result = result.replace(
+      "function MDXContent(props = {}) {",
+      `
 import { useEffect } from 'react';
 
 function MDXContent(props = {}) {
 
   useEffect(() => {
     if (window.location.hash.length !== 0) {
-      // \u4E3A\u4E86\u53F3\u4FA7\u5185\u5BB9\u533A\u80FD\u6B63\u5E38\u8DF3\u8F6C
+      // 为了右侧内容区能正常跳转
       const hash = decodeURIComponent(window.location.hash);
       setTimeout(() => {
         document.getElementById(hash.slice(1))?.scrollIntoView();
@@ -78,12 +83,15 @@ function MDXContent(props = {}) {
     });
   }, []);
 
-`);
+`
+    );
     return { result };
   } catch (e) {
     import_plugin_utils.logger.error(e.reason);
     import_plugin_utils.logger.error(`Above error occurred in ${opts.fileName} at line ${e.line}`);
-    import_plugin_utils.logger.error(opts.content.split("\n").filter((_, i) => i == e.line - 1).join("\n"));
+    import_plugin_utils.logger.error(
+      opts.content.split("\n").filter((_, i) => i == e.line - 1).join("\n")
+    );
     import_plugin_utils.logger.error(" ".repeat(e.column - 1) + "^");
     if (process.env.NODE_ENV === "production") {
       throw new Error("compile error", { cause: e });

package/dist/index.js

@@ -16,7 +16,10 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
@@ -82,7 +85,10 @@ var src_default = (api) => {
     for (const route in r) {
       if (r[route].path.match(/^[a-z]{2}-[A-Z]{2}\/.*/))
         continue;
-      const defaultLangFile = r[route].file.replace(/(.[a-z]{2}-[A-Z]{2})?.md$/, "");
+      const defaultLangFile = r[route].file.replace(
+        /(.[a-z]{2}-[A-Z]{2})?.md$/,
+        ""
+      );
       Object.keys(locales).map((l) => {
         if (r[defaultLangFile] && !r[defaultLangFile + "." + l]) {
           r[defaultLangFile + "." + l] = {
@@ -111,7 +117,9 @@ var src_default = (api) => {
     api.writeTmpFile({
       path: "index.ts",
       content: `
-export { ${exports.filter((item) => !item.startsWith("$")).join(", ")} } from '${(0, import_utils.winPath)(require.resolve("../client/theme-doc/index.ts"))}';
+export { ${exports.filter((item) => !item.startsWith("$")).join(", ")} } from '${(0, import_utils.winPath)(
+        require.resolve("../client/theme-doc/index.ts")
+      )}';
     `
     });
     api.writeTmpFile({
@@ -119,7 +127,9 @@ export { ${exports.filter((item) => !item.startsWith("$")).join(", ")} } from '$
       content: `
 import React from 'react';
 import { useOutlet, useAppData, useLocation, Link, history } from 'umi';
-import { $Layout as Layout } from '${(0, import_utils.winPath)(require.resolve("../client/theme-doc/index.ts"))}';
+import { $Layout as Layout } from '${(0, import_utils.winPath)(
+        require.resolve("../client/theme-doc/index.ts")
+      )}';
 ${themeExists ? `import themeConfig from '${themeConfigPath}'` : `const themeConfig = {}`}
 
 ${injectLocale}
@@ -150,7 +160,11 @@ export default () => {
   });
 };
 function withTmpPath(opts) {
-  return (0, import_path.join)(opts.api.paths.absTmpPath, opts.api.plugin.key && !opts.noPluginDir ? `plugin-${opts.api.plugin.key}` : "", opts.path);
+  return (0, import_path.join)(
+    opts.api.paths.absTmpPath,
+    opts.api.plugin.key && !opts.noPluginDir ? `plugin-${opts.api.plugin.key}` : "",
+    opts.path
+  );
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/plugin-docs",
-  "version": "4.0.46",
+  "version": "4.0.48",
   "description": "@umijs/plugin-docs",
   "homepage": "https://github.com/umijs/umi/tree/master/packages/plugin-docs#readme",
   "bugs": "https://github.com/umijs/umi/issues",
@@ -43,7 +43,7 @@
     "rehype-slug": "5.0.1",
     "remark-gfm": "^3.0.1",
     "tailwindcss": "^3.2.4",
-    "umi": "4.0.46"
+    "umi": "4.0.48"
   },
   "publishConfig": {
     "access": "public"