@umijs/plugin-docs 4.0.0-canary.20230109.1 → 4.0.0-canary.20230201.1

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/client/theme-doc/tailwind.out.css

@@ -1,5 +1,5 @@
 /*
-! tailwindcss v3.1.8 | MIT License | https://tailwindcss.com
+! tailwindcss v3.2.4 | MIT License | https://tailwindcss.com
 */
 
 /*
@@ -30,6 +30,7 @@
 2. Prevent adjustments of font size after orientation changes in iOS.
 3. Use a more readable tab size.
 4. Use the user's configured `sans` font-family by default.
+5. Use the user's configured `sans` font-feature-settings by default.
 */
 
 html {
@@ -44,6 +45,8 @@ html {
   /* 3 */
   font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
   /* 4 */
+  font-feature-settings: normal;
+  /* 5 */
 }
 
 /*
@@ -410,6 +413,12 @@ video {
   height: auto;
 }
 
+/* Make elements with the HTML hidden attribute stay hidden by default */
+
+[hidden] {
+  display: none;
+}
+
 *, ::before, ::after {
   --tw-border-spacing-x: 0;
   --tw-border-spacing-y: 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/plugin-docs",
-  "version": "4.0.0-canary.20230109.1",
+  "version": "4.0.0-canary.20230201.1",
   "description": "@umijs/plugin-docs",
   "homepage": "https://github.com/umijs/umi/tree/master/packages/plugin-docs#readme",
   "bugs": "https://github.com/umijs/umi/issues",
@@ -38,12 +38,12 @@
     "@mdx-js/mdx": "2.1.1",
     "@types/github-slugger": "^1.3.0",
     "@types/keymaster": "^1.6.30",
-    "@types/react-helmet": "^6.1.5",
+    "@types/react-helmet": "^6.1.6",
     "rehype-autolink-headings": "^6.1.1",
     "rehype-slug": "5.0.1",
     "remark-gfm": "^3.0.1",
-    "tailwindcss": "^3.0.24",
-    "umi": "4.0.0-canary.20230109.1"
+    "tailwindcss": "^3.2.4",
+    "umi": "4.0.0-canary.20230201.1"
   },
   "publishConfig": {
     "access": "public"