@umijs/plugin-docs 4.0.0-canary.20220425.2 → 4.0.0-canary.20220428.1

package/client/theme-doc/Search.tsx

@@ -3,9 +3,11 @@ import key from 'keymaster';
 import React, { Fragment, useEffect, useState } from 'react';
 import { useThemeContext } from './context';
 import useLanguage from './useLanguage';
+import getLinkFromTitle from './utils/getLinkFromTitle';
 
 export default () => {
-  const { render } = useLanguage();
+  const { components } = useThemeContext()!;
+  const { isFromPath, currentLanguage, render } = useLanguage();
   const [isFocused, setIsFocused] = useState(false);
   const [keyword, setKeyword] = useState('');
 
@@ -34,6 +36,7 @@ export default () => {
   }
 
   useEffect(() => {
+    if (!themeConfig.searchHotKey) return;
     key.filter = () => true;
 
     // 在页面中按下 ⌘+k 可以打开搜索框
@@ -73,17 +76,20 @@ export default () => {
           onFocus={() => setIsFocused(true)}
           onBlur={() => setIsFocused(false)}
           value={keyword}
+          autoComplete="off"
           onChange={(e) => setKeyword(e.target.value)}
           id="search-input"
           className="w-full bg-transparent outline-none text-sm px-4 py-2"
           placeholder={render('Search anything ...')}
         />
-        <div
-          className="bg-gray-200 rounded px-2 h-6 flex flex-row text-gray-400
+        {themeConfig.searchHotKey && (
+          <div
+            className="bg-gray-200 rounded px-2 h-6 flex flex-row text-gray-400
          items-center justify-center border border-gray-300 text-xs"
-        >
-          {isMac ? macSearchKey : windowsSearchKey}
-        </div>
+          >
+            {isMac ? macSearchKey : windowsSearchKey}
+          </div>
+        )}
         <div
           id="search-results-wrapper"
           className={cx(
@@ -93,8 +99,8 @@ export default () => {
           )}
         >
           {result.map((r, i) => (
-            <a
-              href={r.href}
+            <components.Link
+              to={(isFromPath ? currentLanguage?.locale : '') + r.href}
               key={i}
               className="group outline-none search-result"
               onFocus={() => setIsFocused(true)}
@@ -106,7 +112,7 @@ export default () => {
               >
                 {r.path}
               </p>
-            </a>
+            </components.Link>
           ))}
         </div>
       </div>
@@ -124,9 +130,15 @@ function search(routes: any, keyword: string): SearchResultItem[] {
 
   const result: SearchResultItem[] = [];
 
+  function addResult(newResult: { path: string; href: string }) {
+    const { path, href } = newResult;
+    if (result.find((r) => r.path === path)) return;
+    result.push({ path, href });
+  }
+
   Object.keys(routes).map((path) => {
     if (path.toLowerCase().includes(keyword.toLowerCase())) {
-      result.push({
+      addResult({
         path: path.split('/').slice(1).join(' > '),
         href: '/' + path,
       });
@@ -134,16 +146,21 @@ function search(routes: any, keyword: string): SearchResultItem[] {
 
     const route = routes[path];
     if (!route.titles) return;
-    route.titles
-      .filter((t: any) => t.level <= 2)
-      .map((title: any) => {
-        if (title.title.toLowerCase().includes(keyword.toLowerCase())) {
-          result.push({
-            path: path.split('/').slice(1).join(' > ') + ' > ' + title.title,
-            href: '/' + path + '#' + title.title,
-          });
-        }
-      });
+    route.titles.map((title: any) => {
+      if (title.title.toLowerCase().includes(keyword.toLowerCase())) {
+        addResult({
+          path:
+            path
+              .split('/')
+              .map((s) => s.replace(/\.[a-z]{2}-[A-Z]{2}\/?/g, ''))
+              .slice(1)
+              .join(' > ') +
+            ' > ' +
+            title.title,
+          href: '/' + path + '#' + getLinkFromTitle(title.title),
+        });
+      }
+    });
   });
 
   if (result.length > 8) return result.slice(0, 8);

package/client/theme-doc/Sidebar.tsx

@@ -49,6 +49,7 @@ export default (props: SidebarProps) => {
                 if (to === window.location.pathname) {
                   return (
                     <div
+                      id="active-nav-item"
                       key={route.path}
                       className="my-2 hover:text-blue-400 transition-all
                        bg-blue-50 text-blue-400 px-4 py-1

package/client/theme-doc/Toc.tsx

@@ -2,13 +2,8 @@ import React from 'react';
 import { Helmet } from 'react-helmet';
 import { useThemeContext } from './context';
 import useLanguage from './useLanguage';
-
-function getLinkFromTitle(title: string) {
-  return title
-    .toLowerCase()
-    .replace(/\s/g, '-')
-    .replace(/[（）()\\{},]/g, '');
-}
+import getLinkFromTitle from './utils/getLinkFromTitle';
+import getTocTitle from './utils/getTocTitle';
 
 export default () => {
   const { location, appData, themeConfig } = useThemeContext()!;
@@ -30,7 +25,7 @@ export default () => {
   return (
     <div
       className="w-full lg:m-12 mb-12 border
-      border-gray-100 p-4 rounded-xl z-20"
+      border-gray-200 dark:border-neutral-700 py-4 rounded-lg z-20"
     >
       {/* @ts-ignore */}
       <Helmet>
@@ -38,22 +33,24 @@ export default () => {
           {route.titles[0].title} | {themeConfig.title}
         </title>
       </Helmet>
-      <p className="text-lg font-extrabold dark:text-white">
-        {route.titles[0].title}
+      <p className="text-lg font-extrabold text-gray-800 dark:text-neutral-50 pb-2 border-b border-gray-200 dark:border-neutral-700">
+        <span className="px-4">{route.titles[0].title}</span>
       </p>
-      <ul className="max-h-[calc(100vh-360px)] overflow-y-auto py-2">
+      <ul className="max-h-[calc(100vh-360px)] overflow-y-auto px-4">
         {titles.map((item: any) => {
           return (
             <li
               style={{ paddingLeft: `${item.level - 2}rem` }}
-              className="mt-3 text-gray-600 cursor-pointer dark:text-gray-400
+              className="mt-3 text-gray-600 cursor-pointer dark:text-neutral-400
               hover:text-blue-500 transition duration-300 dark:hover:text-blue-500"
             >
               <a
-                className={item.level > 2 ? 'text-sm' : ''}
+                className={`${
+                  item.level > 2 ? 'text-sm' : 'text-base'
+                } break-all 2xl:break-words`}
                 href={'#' + getLinkFromTitle(item.title)}
               >
-                {item.title.replace(/\\{/g, '{').replace(/\\}/g, '}')}
+                {getTocTitle(item.title)}
               </a>
             </li>
           );

package/client/theme-doc/components/Features.tsx

@@ -8,7 +8,7 @@ function Features(
   props: PropsWithChildren<{ title?: string; subtitle?: string }>,
 ) {
   return (
-    <div className="w-screen py-36 features dark:features-dark min-h-screen">
+    <div className="w-full py-36 features dark:features-dark min-h-screen">
       {(props.title || props.subtitle) && (
         <div className="mb-24 px-4">
           {props.title && (

package/client/theme-doc/tailwind.css

@@ -78,7 +78,9 @@ article div[data-rehype-pretty-code-fragment] {
 }
 
 /* 代码块的标题部分 */
-article div[data-rehype-pretty-code-fragment] > div[data-rehype-pretty-code-title] {
+article
+  div[data-rehype-pretty-code-fragment]
+  > div[data-rehype-pretty-code-title] {
   @apply pb-1 text-sm text-zinc-400 dark:text-neutral-400 text-center;
 }
 

package/client/theme-doc/tailwind.out.css

@@ -1046,6 +1046,10 @@ Ensure the default browser behavior of the `hidden` attribute.
   overflow-y: scroll;
 }
 
+.break-all {
+  word-break: break-all;
+}
+
 .rounded-lg {
   border-radius: 0.5rem;
 }
@@ -1070,6 +1074,10 @@ Ensure the default browser behavior of the `hidden` attribute.
   border-bottom-width: 2px;
 }
 
+.border-b {
+  border-bottom-width: 1px;
+}
+
 .border-white {
   --tw-border-opacity: 1;
   border-color: rgb(255 255 255 / var(--tw-border-opacity));
@@ -1080,9 +1088,9 @@ Ensure the default browser behavior of the `hidden` attribute.
   border-color: rgb(209 213 219 / var(--tw-border-opacity));
 }
 
-.border-gray-100 {
+.border-gray-200 {
   --tw-border-opacity: 1;
-  border-color: rgb(243 244 246 / var(--tw-border-opacity));
+  border-color: rgb(229 231 235 / var(--tw-border-opacity));
 }
 
 .border-b-gray-100 {
@@ -1186,6 +1194,11 @@ Ensure the default browser behavior of the `hidden` attribute.
   padding-right: 0.25rem;
 }
 
+.py-4 {
+  padding-top: 1rem;
+  padding-bottom: 1rem;
+}
+
 .py-12 {
   padding-top: 3rem;
   padding-bottom: 3rem;
@@ -1230,6 +1243,10 @@ Ensure the default browser behavior of the `hidden` attribute.
   padding-bottom: 9rem;
 }
 
+.pb-2 {
+  padding-bottom: 0.5rem;
+}
+
 .pb-12 {
   padding-bottom: 3rem;
 }
@@ -1258,6 +1275,11 @@ Ensure the default browser behavior of the `hidden` attribute.
   line-height: 1.75rem;
 }
 
+.text-base {
+  font-size: 1rem;
+  line-height: 1.5rem;
+}
+
 .text-3xl {
   font-size: 1.875rem;
   line-height: 2.25rem;
@@ -1296,6 +1318,11 @@ Ensure the default browser behavior of the `hidden` attribute.
   color: rgb(55 65 81 / var(--tw-text-opacity));
 }
 
+.text-gray-800 {
+  --tw-text-opacity: 1;
+  color: rgb(31 41 55 / var(--tw-text-opacity));
+}
+
 .text-gray-600 {
   --tw-text-opacity: 1;
   color: rgb(75 85 99 / var(--tw-text-opacity));
@@ -1678,7 +1705,9 @@ article div[data-rehype-pretty-code-fragment] {
 
 /* 代码块的标题部分 */
 
-article div[data-rehype-pretty-code-fragment] > div[data-rehype-pretty-code-title] {
+article
+  div[data-rehype-pretty-code-fragment]
+  > div[data-rehype-pretty-code-title] {
   padding-bottom: 0.25rem;
   text-align: center;
   font-size: 0.875rem;
@@ -1687,7 +1716,9 @@ article div[data-rehype-pretty-code-fragment] > div[data-rehype-pretty-code-titl
   color: rgb(161 161 170 / var(--tw-text-opacity));
 }
 
-.dark article div[data-rehype-pretty-code-fragment] > div[data-rehype-pretty-code-title] {
+.dark article
+  div[data-rehype-pretty-code-fragment]
+  > div[data-rehype-pretty-code-title] {
   --tw-text-opacity: 1;
   color: rgb(163 163 163 / var(--tw-text-opacity));
 }
@@ -2132,6 +2163,11 @@ h6 {
   border-color: rgb(55 65 81 / var(--tw-border-opacity));
 }
 
+.dark .dark\:border-neutral-700 {
+  --tw-border-opacity: 1;
+  border-color: rgb(64 64 64 / var(--tw-border-opacity));
+}
+
 .dark .dark\:border-gray-500 {
   --tw-border-opacity: 1;
   border-color: rgb(107 114 128 / var(--tw-border-opacity));
@@ -2182,9 +2218,14 @@ h6 {
   color: rgb(191 219 254 / var(--tw-text-opacity));
 }
 
-.dark .dark\:text-gray-400 {
+.dark .dark\:text-neutral-50 {
   --tw-text-opacity: 1;
-  color: rgb(156 163 175 / var(--tw-text-opacity));
+  color: rgb(250 250 250 / var(--tw-text-opacity));
+}
+
+.dark .dark\:text-neutral-400 {
+  --tw-text-opacity: 1;
+  color: rgb(163 163 163 / var(--tw-text-opacity));
 }
 
 .dark .dark\:text-gray-200 {
@@ -2192,6 +2233,11 @@ h6 {
   color: rgb(229 231 235 / var(--tw-text-opacity));
 }
 
+.dark .dark\:text-gray-400 {
+  --tw-text-opacity: 1;
+  color: rgb(156 163 175 / var(--tw-text-opacity));
+}
+
 .dark .dark\:text-gray-300 {
   --tw-text-opacity: 1;
   color: rgb(209 213 219 / var(--tw-text-opacity));
@@ -2355,3 +2401,9 @@ h6 {
     padding-right: 16rem;
   }
 }
+
+@media (min-width: 1536px) {
+  .\32xl\:break-words {
+    overflow-wrap: break-word;
+  }
+}

package/client/theme-doc/utils/getLinkFromTitle.ts

@@ -0,0 +1,15 @@
+export default function getLinkFromTitle(title: string) {
+  return (
+    title
+      .toLowerCase()
+      .trim()
+      // not remove html tags
+      // .replace(/<[!\/a-z].*?>/gi, '')
+      // remove unwanted chars
+      .replace(
+        /[\u2000-\u206F\u2E00-\u2E7F\\'!！"#$%&()（）*+,，.。/:：;；<=>?？@[\]^`{|}~]/g,
+        '',
+      )
+      .replace(/\s/g, '-')
+  );
+}

package/client/theme-doc/utils/getTocTitle.ts

@@ -0,0 +1,9 @@
+export const getTocTitle = (title: string) => {
+  return title
+    .trim()
+    .replace(/\\{/g, '{')
+    .replace(/\\}/g, '}')
+    .replace(/[`]/g, '');
+};
+
+export default getTocTitle;

package/dist/compiler.js

@@ -61,6 +61,10 @@ function MDXContent(props = {}) {
     } else {
       window.scrollTo(0, 0);
     }
+    document.getElementById('active-nav-item')?.scrollIntoView({
+      behavior: 'smooth',
+      block: 'center'
+    });
   }, []);
 
 `);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/plugin-docs",
-  "version": "4.0.0-canary.20220425.2",
+  "version": "4.0.0-canary.20220428.1",
   "description": "@umijs/plugin-docs",
   "homepage": "https://github.com/umijs/umi-next/tree/master/packages/plugin-docs#readme",
   "bugs": "https://github.com/umijs/umi-next/issues",
@@ -39,7 +39,7 @@
     "rehype-slug": "5.0.1",
     "remark-gfm": "^3.0.1",
     "tailwindcss": "^3.0.23",
-    "umi": "4.0.0-canary.20220425.2"
+    "umi": "4.0.0-canary.20220428.1"
   },
   "publishConfig": {
     "access": "public"