@easyops-cn/docusaurus-search-local 0.19.0 → 0.21.1

package/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.21.1](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.21.0...v0.21.1) (2021-12-07)
+
+
+### Bug Fixes
+
+* fix input box style of search page in dark mode ([f233bce](https://www.github.com/easyops-cn/docusaurus-search-local/commit/f233bcedb4d79cba9b8d21f700ca79f2297f0ec9)), closes [#125](https://www.github.com/easyops-cn/docusaurus-search-local/issues/125)
+
+## [0.21.0](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.20.0...v0.21.0) (2021-12-04)
+
+
+### Features
+
+* add shortcut (cmd/ctrl + K) support ([f12403f](https://www.github.com/easyops-cn/docusaurus-search-local/commit/f12403fc6bc48b489d8ef170aecad2262f3a4ebc))
+
+## [0.20.0](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.19.1...v0.20.0) (2021-11-12)
+
+
+### Features
+
+* remove nodejieba from peerDependencies ([e76bb64](https://www.github.com/easyops-cn/docusaurus-search-local/commit/e76bb6490b749cab6b17607349ab04f226d8eee4))
+
+### [0.19.1](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.19.0...v0.19.1) (2021-08-03)
+
+
+### Bug Fixes
+
+* fix docsRouteBasePath or blogRouteBasePath set to "/" ([a1b1df6](https://www.github.com/easyops-cn/docusaurus-search-local/commit/a1b1df6d59ab309ca68c18494ac72f8aa6a1b370))
+* fix search page ignore ([9841cc8](https://www.github.com/easyops-cn/docusaurus-search-local/commit/9841cc8b910d5a1b2ea9fe896ec5acdde0b2faf0))
+* refine get site config ([e215a1a](https://www.github.com/easyops-cn/docusaurus-search-local/commit/e215a1a5ceef1751233996e5a48c57fa9ca25d1e))
+
 ## [0.19.0](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.18.1...v0.19.0) (2021-08-03)
 
 

package/README.md

@@ -67,7 +67,7 @@ module.exports = {
 
 > Notice!
 >
-> When applying `"zh"` in language, please also install `nodejieba` in your project, it became a peer dependency since v0.7.0.
+> When applying `"zh"` in language, please also install `nodejieba` in your project, which is required for tokenizing Chinese words. It is removed from peerDependencies since v0.20.0, so you have to install it manually even if you're using npm v7+.
 
 ```shell
 npm install nodejieba

package/dist/client/client/theme/SearchBar/SearchBar.jsx

@@ -152,10 +152,34 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             setInputChanged(true);
         }
     }, []);
+    // Implement hint icons for the search shortcuts on mac and the rest operating systems.
+    const isMac = ExecutionEnvironment.canUseDOM
+        ? /mac/i.test(navigator.userAgentData?.platform ?? navigator.platform)
+        : false;
+    useEffect(() => {
+        // Add shortcuts command/ctrl + K
+        function handleShortcut(event) {
+            if ((isMac ? event.metaKey : event.ctrlKey) && event.code === "KeyK") {
+                event.preventDefault();
+                searchBarRef.current?.focus();
+            }
+        }
+        // "keydown" is the only way to capture the "command" key on mac.
+        // Then we use the metaKey boolean prop to see if the "command" key was pressed.
+        const eventType = isMac ? "keydown" : "keypress";
+        document.addEventListener(eventType, handleShortcut);
+        return () => {
+            document.removeEventListener(eventType, handleShortcut);
+        };
+    }, [isMac]);
     return (<div className={clsx("navbar__search", styles.searchBarContainer, {
         [styles.searchIndexLoading]: loading && inputChanged,
     })}>
       <input placeholder={translations.search_placeholder} aria-label="Search" className="navbar__search-input" onMouseEnter={onInputMouseEnter} onFocus={onInputFocus} onBlur={onInputBlur} onChange={onInputChange} ref={searchBarRef}/>
       <LoadingRing className={styles.searchBarLoadingRing}/>
+      <div className={styles.searchHintContainer}>
+        <kbd className={styles.searchHint}>{isMac ? "⌘" : "ctrl"}</kbd>
+        <kbd className={styles.searchHint}>K</kbd>
+      </div>
     </div>);
 }

package/dist/client/client/theme/SearchBar/SearchBar.module.css

@@ -189,7 +189,7 @@ html[data-theme="dark"] .noResultsIcon {
 .searchBarContainer .searchBarLoadingRing {
   display: none;
   position: absolute;
-  left: calc(var(--ifm-navbar-padding-horizontal) + 10px);
+  left: 10px;
   top: 6px;
 }
 
@@ -205,6 +205,28 @@ html[data-theme="dark"] .noResultsIcon {
   display: inline-block;
 }
 
+.searchHintContainer {
+  position: absolute;
+  right: 10px;
+  top: 0px;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  height: 100%;
+  pointer-events: none;
+  gap: 4px;
+}
+
+.searchHint {
+  color: var(--ifm-navbar-search-input-placeholder-color);
+}
+
+@media (max-width: 576px) {
+  .searchHintContainer {
+    display: none;
+  }
+}
+
 /* For autocomplete.js only. */
 .input {
 }

package/dist/client/client/theme/SearchPage/SearchPage.module.css

@@ -5,7 +5,8 @@
   font-size: var(--ifm-font-size-base);
   padding: 0.5rem;
   width: 100%;
-  background: #fff;
+  background: var(--ifm-background-color);
+  color: var(--ifm-font-color-base);
   margin-bottom: 1rem;
 }
 

package/dist/server/server/index.js

@@ -21,7 +21,7 @@ function DocusaurusSearchLocalPlugin(context, options) {
         getThemePath() {
             return themePath;
         },
-        postBuild: postBuildFactory_1.postBuildFactory(config, context.siteConfig),
+        postBuild: postBuildFactory_1.postBuildFactory(config),
         getPathsToWatch() {
             return [pagePath];
         },

package/dist/server/server/utils/postBuildFactory.js

@@ -10,11 +10,11 @@ const debug_1 = require("./debug");
 const processDocInfos_1 = require("./processDocInfos");
 const scanDocuments_1 = require("./scanDocuments");
 const writeFileAsync = util_1.default.promisify(fs_1.default.writeFile);
-function postBuildFactory(config, siteConfig) {
+function postBuildFactory(config) {
     return function postBuild(buildData) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             debug_1.debugInfo("gathering documents");
-            const data = processDocInfos_1.processDocInfos(buildData, config, siteConfig);
+            const data = processDocInfos_1.processDocInfos(buildData, config);
             debug_1.debugInfo("parsing documents");
             // Give every index entry a unique id so that the index does not need to store long URLs.
             const allDocuments = yield scanDocuments_1.scanDocuments(data);

package/dist/server/server/utils/processDocInfos.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processDocInfos = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
-function processDocInfos({ routesPaths, outDir, baseUrl }, { indexDocs, indexBlog, indexPages, docsRouteBasePath, blogRouteBasePath, ignoreFiles, }, siteConfig) {
+function processDocInfos({ routesPaths, outDir, baseUrl, siteConfig }, { indexDocs, indexBlog, indexPages, docsRouteBasePath, blogRouteBasePath, ignoreFiles, }) {
     return routesPaths
         .map((url) => {
         // istanbul ignore next
@@ -12,12 +12,7 @@ function processDocInfos({ routesPaths, outDir, baseUrl }, { indexDocs, indexBlo
         }
         const route = url.substr(baseUrl.length).replace(/\/$/, "");
         // Do not index homepage, error page and search page.
-        if (route === "" ||
-            route === "404.html" ||
-            route ===
-                (siteConfig.trailingSlash === false
-                    ? "search.html"
-                    : "search/index.html")) {
+        if (route === "" || route === "404.html" || route === "search") {
             return;
         }
         // ignore files
@@ -32,7 +27,7 @@ function processDocInfos({ routesPaths, outDir, baseUrl }, { indexDocs, indexBlo
         if (indexBlog &&
             blogRouteBasePath.some((basePath) => isSameOrSubRoute(route, basePath))) {
             if (blogRouteBasePath.some((basePath) => isSameRoute(route, basePath) ||
-                isSameOrSubRoute(route, `${basePath}/tags`))) {
+                isSameOrSubRoute(route, path_1.default.posix.join(basePath, "tags")))) {
                 // Do not index list of blog posts and tags filter pages
                 return;
             }
@@ -61,7 +56,8 @@ function isSameRoute(routeA, routeB) {
     return addTrailingSlash(routeA) === addTrailingSlash(routeB);
 }
 function isSameOrSubRoute(childRoute, parentRoute) {
-    return addTrailingSlash(childRoute).startsWith(addTrailingSlash(parentRoute));
+    return (parentRoute === "" ||
+        addTrailingSlash(childRoute).startsWith(addTrailingSlash(parentRoute)));
 }
 // The input route must not end with a slash.
 function addTrailingSlash(route) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.19.0",
+  "version": "0.21.1",
   "description": "An offline/local search plugin for Docusaurus v2.",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",
@@ -78,8 +78,5 @@
     "rimraf": "^3.0.2",
     "standard-version": "^9.0.0",
     "typescript": "^4.0.3"
-  },
-  "peerDependencies": {
-    "nodejieba": "^2.4.1"
   }
 }