@easyops-cn/docusaurus-search-local 0.40.0 → 0.41.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.41.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.40.1...v0.41.0) (2024-05-23)
+
+
+### Features
+
+* support search based on description and keywords ([0c12b59](https://github.com/easyops-cn/docusaurus-search-local/commit/0c12b59866c6d9b7bfa342b4f87e40b01b5f7d48)), closes [#344](https://github.com/easyops-cn/docusaurus-search-local/issues/344)
+
+## [0.40.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.40.0...v0.40.1) (2023-12-23)
+
+
+### Bug Fixes
+
+* fix search page no results, closes [#389](https://github.com/easyops-cn/docusaurus-search-local/issues/389) ([64e26c2](https://github.com/easyops-cn/docusaurus-search-local/commit/64e26c2bd9f20257e77089adf9dc697d353e5c0e))
+
 ## [0.40.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.39.0...v0.40.0) (2023-12-19)
 
 

package/dist/client/client/theme/SearchBar/SuggestionTemplate.js

@@ -1,3 +1,4 @@
+import { SearchDocumentType, } from "../../../shared/interfaces";
 import { concatDocumentPath } from "../../utils/concatDocumentPath";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import { highlight } from "../../utils/highlight";
@@ -6,8 +7,10 @@ import { explicitSearchResultPath } from "../../utils/proxiedGenerated";
 import { iconAction, iconContent, iconHeading, iconTitle, iconTreeInter, iconTreeLast, } from "./icons";
 import styles from "./SearchBar.module.css";
 export function SuggestionTemplate({ document, type, page, metadata, tokens, isInterOfTree, isLastOfTree, }) {
-    const isTitle = type === 0;
-    const isHeading = type === 1;
+    const isTitle = type === SearchDocumentType.Title;
+    const isKeywords = type === SearchDocumentType.Keywords;
+    const isTitleRelated = isTitle || isKeywords;
+    const isHeading = type === SearchDocumentType.Heading;
     const tree = [];
     if (isInterOfTree) {
         tree.push(iconTreeInter);
@@ -16,20 +19,22 @@ export function SuggestionTemplate({ document, type, page, metadata, tokens, isI
         tree.push(iconTreeLast);
     }
     const treeWrapper = tree.map((item) => `<span class="${styles.hitTree}">${item}</span>`);
-    const icon = `<span class="${styles.hitIcon}">${isTitle ? iconTitle : isHeading ? iconHeading : iconContent}</span>`;
+    const icon = `<span class="${styles.hitIcon}">${isTitleRelated ? iconTitle : isHeading ? iconHeading : iconContent}</span>`;
     const wrapped = [
-        `<span class="${styles.hitTitle}">${highlightStemmed(document.t, getStemmedPositions(metadata, "t"), tokens)}</span>`,
+        `<span class="${styles.hitTitle}">${isKeywords
+            ? highlight(document.s, tokens)
+            : highlightStemmed(document.t, getStemmedPositions(metadata, "t"), tokens)}</span>`,
     ];
     const needsExplicitHitPath = !isInterOfTree && !isLastOfTree && explicitSearchResultPath;
     if (needsExplicitHitPath) {
         const pathItems = page
-            ? (page.b ?? [])
-                .concat(page.t)
+            ? page.b
+                ?.concat(page.t)
                 .concat(!document.s || document.s === page.t ? [] : document.s)
             : document.b;
         wrapped.push(`<span class="${styles.hitPath}">${concatDocumentPath(pathItems ?? [])}</span>`);
     }
-    else if (!isTitle) {
+    else if (!isTitleRelated) {
         wrapped.push(`<span class="${styles.hitPath}">${highlight(page.t ||
             // Todo(weareoutman): This is for EasyOps only.
             // istanbul ignore next

package/dist/client/client/theme/SearchPage/SearchPage.jsx

@@ -9,6 +9,7 @@ import clsx from "clsx";
 import useSearchQuery from "../hooks/useSearchQuery";
 import { fetchIndexes } from "../SearchBar/fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
+import { SearchDocumentType, } from "../../../shared/interfaces";
 import { highlight } from "../../utils/highlight";
 import { highlightStemmed } from "../../utils/highlightStemmed";
 import { getStemmedPositions } from "../../utils/getStemmedPositions";
@@ -68,7 +69,9 @@ function SearchPageContent() {
     }, [searchValue]);
     useEffect(() => {
         async function doFetchIndexes() {
-            const { wrappedIndexes, zhDictionary } = searchContext || useAllContextsWithNoSearchContext
+            const { wrappedIndexes, zhDictionary } = !Array.isArray(searchContextByPaths) ||
+                searchContext ||
+                useAllContextsWithNoSearchContext
                 ? await fetchIndexes(versionUrl, searchContext)
                 : { wrappedIndexes: [], zhDictionary: [] };
             setSearchSource(() => SearchSourceFactory(wrappedIndexes, zhDictionary, 100));
@@ -144,11 +147,15 @@ function SearchPageContent() {
     </React.Fragment>);
 }
 function SearchResultItem({ searchResult: { document, type, page, tokens, metadata }, }) {
-    const isTitle = type === 0;
-    const isContent = type === 2;
+    const isTitle = type === SearchDocumentType.Title;
+    const isKeywords = type === SearchDocumentType.Keywords;
+    const isDescription = type === SearchDocumentType.Description;
+    const isDescriptionOrKeywords = isDescription || isKeywords;
+    const isTitleRelated = isTitle || isDescriptionOrKeywords;
+    const isContent = type === SearchDocumentType.Content;
     const pathItems = (isTitle ? document.b : page.b).slice();
-    const articleTitle = (isContent ? document.s : document.t);
-    if (!isTitle) {
+    const articleTitle = (isContent || isDescriptionOrKeywords ? document.s : document.t);
+    if (!isTitleRelated) {
         pathItems.push(page.t);
     }
     let search = "";
@@ -162,7 +169,7 @@ function SearchResultItem({ searchResult: { document, type, page, tokens, metada
     return (<article className={styles.searchResultItem}>
       <h2>
         <Link to={document.u + search + (document.h || "")} dangerouslySetInnerHTML={{
-            __html: isContent
+            __html: isContent || isDescriptionOrKeywords
                 ? highlight(articleTitle, tokens)
                 : highlightStemmed(articleTitle, getStemmedPositions(metadata, "t"), tokens, 100),
         }}></Link>
@@ -170,7 +177,7 @@ function SearchResultItem({ searchResult: { document, type, page, tokens, metada
       {pathItems.length > 0 && (<p className={styles.searchResultItemPath}>
           {concatDocumentPath(pathItems)}
         </p>)}
-      {isContent && (<p className={styles.searchResultItemSummary} dangerouslySetInnerHTML={{
+      {(isContent || isDescription) && (<p className={styles.searchResultItemSummary} dangerouslySetInnerHTML={{
                 __html: highlightStemmed(document.t, getStemmedPositions(metadata, "t"), tokens, 100),
             }}/>)}
     </article>);

package/dist/client/client/utils/SearchSourceFactory.js

@@ -1,5 +1,6 @@
 import { tokenize } from "./tokenize";
 import { smartQueries } from "./smartQueries";
+import { SearchDocumentType, } from "../../shared/interfaces";
 import { sortSearchResults } from "./sortSearchResults";
 import { processTreeStatusOfSearchResults } from "./processTreeStatusOfSearchResults";
 import { language } from "./proxiedGenerated";
@@ -32,7 +33,7 @@ export function SearchSourceFactory(wrappedIndexes, zhDictionary, resultsLimit)
                     return {
                         document,
                         type,
-                        page: type !== 0 &&
+                        page: type !== SearchDocumentType.Title &&
                             wrappedIndexes[0].documents.find((doc) => doc.i === document.p),
                         metadata: result.matchData.metadata,
                         tokens,

package/dist/client/client/utils/processTreeStatusOfSearchResults.js

@@ -1,8 +1,13 @@
+import { SearchDocumentType, } from "../../shared/interfaces";
 export function processTreeStatusOfSearchResults(results) {
     results.forEach((item, i) => {
         if (i > 0 &&
             item.page &&
-            results.some((prev) => prev.document === item.page)) {
+            results
+                .slice(0, i)
+                .some((prev) => (prev.type === SearchDocumentType.Keywords
+                ? prev.page
+                : prev.document) === item.page)) {
             if (i < results.length - 1 && results[i + 1].page === item.page) {
                 item.isInterOfTree = true;
             }

package/dist/client/client/utils/sortSearchResults.js

@@ -1,14 +1,21 @@
+import { SearchDocumentType, } from "../../shared/interfaces";
 export function sortSearchResults(results) {
     results.forEach((item, index) => {
         item.index = index;
     });
-    // Put search results of headings and contents just after
+    // Put search results of headings/contents/descriptions just after
     // their belonged page's title, if existed.
     results.sort((a, b) => {
-        let aPageIndex = a.type > 0 && a.page
+        let aPageIndex = (a.type === SearchDocumentType.Heading ||
+            a.type === SearchDocumentType.Content ||
+            a.type === SearchDocumentType.Description) &&
+            a.page
             ? results.findIndex((item) => item.document === a.page)
             : a.index;
-        let bPageIndex = b.type > 0 && b.page
+        let bPageIndex = (b.type === SearchDocumentType.Heading ||
+            b.type === SearchDocumentType.Content ||
+            b.type === SearchDocumentType.Description) &&
+            b.page
             ? results.findIndex((item) => item.document === b.page)
             : b.index;
         if (aPageIndex === -1) {
@@ -18,13 +25,8 @@ export function sortSearchResults(results) {
             bPageIndex = b.index;
         }
         if (aPageIndex === bPageIndex) {
-            if (a.type === 0) {
-                return -1;
-            }
-            if (b.type === 0) {
-                return 1;
-            }
-            return a.index - b.index;
+            const diff = (b.type === 0 ? 1 : 0) - (a.type === 0 ? 1 : 0);
+            return diff === 0 ? a.index - b.index : diff;
         }
         return aPageIndex - bPageIndex;
     });

package/dist/client/shared/interfaces.js

@@ -1 +1,8 @@
-export {};
+export var SearchDocumentType;
+(function (SearchDocumentType) {
+    SearchDocumentType[SearchDocumentType["Title"] = 0] = "Title";
+    SearchDocumentType[SearchDocumentType["Heading"] = 1] = "Heading";
+    SearchDocumentType[SearchDocumentType["Description"] = 2] = "Description";
+    SearchDocumentType[SearchDocumentType["Keywords"] = 3] = "Keywords";
+    SearchDocumentType[SearchDocumentType["Content"] = 4] = "Content";
+})(SearchDocumentType || (SearchDocumentType = {}));

package/dist/server/server/utils/parseDocument.js

@@ -8,6 +8,8 @@ const HEADINGS = "h1, h2, h3";
 function parseDocument($) {
     const $pageTitle = $("article h1").first();
     const pageTitle = $pageTitle.text();
+    const description = $("meta[name='description']").attr("content") || "";
+    const keywords = $("meta[name='keywords']").attr("content") || "";
     const sections = [];
     const breadcrumb = [];
     const navbarActiveItem = $(".navbar__link--active");
@@ -82,6 +84,6 @@ function parseDocument($) {
             content,
         });
     });
-    return { pageTitle, sections, breadcrumb };
+    return { pageTitle, description, keywords, sections, breadcrumb };
 }
 exports.parseDocument = parseDocument;

package/dist/server/server/utils/parsePage.js

@@ -10,12 +10,16 @@ function parsePage($, url) {
         $pageTitle = $("title");
     }
     const pageTitle = $pageTitle.text();
+    const description = $("meta[name='description']").attr("content") || "";
+    const keywords = $("meta[name='keywords']").attr("content") || "";
     const $main = $("main");
     if ($main.length === 0) {
         (0, debug_1.debugWarn)("page has no <main>, therefore no content was indexed for this page %o", url);
     }
     return {
         pageTitle,
+        description,
+        keywords,
         sections: [
             {
                 title: pageTitle,

package/dist/server/server/utils/scanDocuments.js

@@ -16,8 +16,16 @@ function scanDocuments(DocInfoWithFilePathList, config) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const titleDocuments = [];
         const headingDocuments = [];
+        const descriptionDocuments = [];
+        const keywordsDocuments = [];
         const contentDocuments = [];
-        const allDocuments = [titleDocuments, headingDocuments, contentDocuments];
+        const allDocuments = [
+            titleDocuments,
+            headingDocuments,
+            descriptionDocuments,
+            keywordsDocuments,
+            contentDocuments,
+        ];
         yield Promise.all(DocInfoWithFilePathList.map(({ filePath, url, type }) => tslib_1.__awaiter(this, void 0, void 0, function* () {
             (0, debug_1.debugVerbose)(`parsing %s file %o of %o`, type, path_1.default.relative(process.cwd(), filePath), url);
             const html = yield readFileAsync(filePath, { encoding: "utf8" });
@@ -26,7 +34,7 @@ function scanDocuments(DocInfoWithFilePathList, config) {
                 // Unlisted content
                 return;
             }
-            const { pageTitle, sections, breadcrumb } = parsed;
+            const { pageTitle, description, keywords, sections, breadcrumb } = parsed;
             const titleId = getNextDocId();
             titleDocuments.push({
                 i: titleId,
@@ -34,6 +42,24 @@ function scanDocuments(DocInfoWithFilePathList, config) {
                 u: url,
                 b: breadcrumb,
             });
+            if (description) {
+                descriptionDocuments.push({
+                    i: titleId,
+                    t: description,
+                    s: pageTitle,
+                    u: url,
+                    p: titleId,
+                });
+            }
+            if (keywords) {
+                keywordsDocuments.push({
+                    i: titleId,
+                    t: keywords,
+                    s: pageTitle,
+                    u: url,
+                    p: titleId,
+                });
+            }
             for (const section of sections) {
                 if (section.title !== pageTitle) {
                     headingDocuments.push({

package/dist/server/shared/interfaces.js

@@ -1,2 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchDocumentType = void 0;
+var SearchDocumentType;
+(function (SearchDocumentType) {
+    SearchDocumentType[SearchDocumentType["Title"] = 0] = "Title";
+    SearchDocumentType[SearchDocumentType["Heading"] = 1] = "Heading";
+    SearchDocumentType[SearchDocumentType["Description"] = 2] = "Description";
+    SearchDocumentType[SearchDocumentType["Keywords"] = 3] = "Keywords";
+    SearchDocumentType[SearchDocumentType["Content"] = 4] = "Content";
+})(SearchDocumentType || (exports.SearchDocumentType = SearchDocumentType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",