@easyops-cn/docusaurus-search-local 0.23.0 → 0.23.3

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 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.23.3](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.23.2...v0.23.3) (2022-05-18)
+
+
+### Bug Fixes
+
+* Update getIndexHash.ts to support mdx and traverseAll ([#172](https://www.github.com/easyops-cn/docusaurus-search-local/issues/172)) ([717942e](https://www.github.com/easyops-cn/docusaurus-search-local/commit/717942e9caf36e37a0f119d9fdaa50e591339d9c))
+
+### [0.23.2](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.23.1...v0.23.2) (2022-04-25)
+
+
+### Bug Fixes
+
+* install cheerio types ([0a45f41](https://www.github.com/easyops-cn/docusaurus-search-local/commit/0a45f41bd02d8305328705bcc6582b92ed2ccf78))
+
+### [0.23.1](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.23.0...v0.23.1) (2022-04-07)
+
+
+### Bug Fixes
+
+* parse `h1` from the whole `article` ([aeb063a](https://www.github.com/easyops-cn/docusaurus-search-local/commit/aeb063af9dbac9778e3436aa261e0c131a2ef8c2))
+
 ## [0.23.0](https://www.github.com/easyops-cn/docusaurus-search-local/compare/v0.22.0...v0.23.0) (2022-03-10)
 
 

package/README.md

@@ -73,7 +73,7 @@ module.exports = {
 | indexDocs                        | boolean                                  | `true`       | Whether to index docs.                                                                                                                       |
 | indexBlog                        | boolean                                  | `true`       | Whether to index blog.                                                                                                                       |
 | indexPages                       | boolean                                  | `false`      | Whether to index pages.                                                                                                                      |
-| docsRouteBasePath                | string \| string[]                       | `"/docs"`    | Base route path(s) of docs. Slash at beginning is not required.                                                                              |
+| docsRouteBasePath                | string \| string[]                       | `"/docs"`    | Base route path(s) of docs. Slash at beginning is not required. Note: for [docs-only mode](https://docusaurus.io/docs/docs-introduction#docs-only-mode), this needs to be the same as `routeBasePath` in your `@docusaurus/preset-classic` config e.g., `"/"`.                                                                               |
 | blogRouteBasePath                | string \| string[]                       | `"/blog"`    | Base route path(s) of blog. Slash at beginning is not required.                                                                              |
 | language                         | string \| string[]                       | `"en"`       | All [lunr-languages](https://github.com/MihaiValentin/lunr-languages) supported languages, + `zh` 🔥.                                        |
 | hashed                           | boolean                                  | `false`      | Whether to add a hashed query when fetching index (based on the content hash of all indexed `*.md` in `docsDir` and `blogDir` if applicable) |
@@ -83,6 +83,7 @@ module.exports = {
 | highlightSearchTermsOnTargetPage | boolean                                  | `false`      | Highlight search terms on target page.                                                                                                       |
 | searchResultLimits               | number                                   | `8`          | Limit the search results.                                                                                                                    |
 | searchResultContextMaxLength     | number                                   | `50`         | Set the max length of characters of each search result to show.                                                                              |
+| explicitSearchResultPath         | boolean                                  | false        | Whether an explicit path to a heading should be presented on a suggestion template.                                                          |
 | translations                     | TranslationMap                           | -            | Set translations of this theme, see [docs below](#translations).                                                                             |
 | ignoreFiles                      | string \| RegExp \| (string \| RegExp)[] | /**meta**\$/ | Set the match rules to ignore some files.                                                                                                    |
 

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

@@ -1,7 +1,9 @@
+import { concatDocumentPath } from "../../utils/concatDocumentPath";
+import { getStemmedPositions } from "../../utils/getStemmedPositions";
 import { highlight } from "../../utils/highlight";
 import { highlightStemmed } from "../../utils/highlightStemmed";
-import { getStemmedPositions } from "../../utils/getStemmedPositions";
-import { iconTitle, iconHeading, iconContent, iconAction, iconTreeInter, iconTreeLast, } from "./icons";
+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;
@@ -18,7 +20,14 @@ export function SuggestionTemplate({ document, type, page, metadata, tokens, isI
     const wrapped = [
         `<span class="${styles.hitTitle}">${highlightStemmed(document.t, getStemmedPositions(metadata, "t"), tokens)}</span>`,
     ];
-    if (!isTitle) {
+    const needsExplicitHitPath = !isInterOfTree && !isLastOfTree && explicitSearchResultPath;
+    if (needsExplicitHitPath) {
+        const pathItems = page
+            ? (page.b ?? []).concat(page.t).concat(document.s ?? [])
+            : document.b;
+        wrapped.push(`<span class="${styles.hitPath}">${concatDocumentPath(pathItems ?? [])}</span>`);
+    }
+    else if (!isTitle) {
         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

@@ -13,6 +13,7 @@ import LoadingRing from "../LoadingRing/LoadingRing";
 import { translations } from "../../utils/proxiedGenerated";
 import { simpleTemplate } from "../../utils/simpleTemplate";
 import styles from "./SearchPage.module.css";
+import { concatDocumentPath } from "../../utils/concatDocumentPath";
 export default function SearchPage() {
     const { siteConfig: { baseUrl }, } = useDocusaurusContext();
     const { searchValue, updateSearchPath } = useSearchQuery();
@@ -54,10 +55,11 @@ export default function SearchPage() {
         }
         doFetchIndexes();
     }, [baseUrl]);
-    return (<Layout title={pageTitle}>
+    return (<Layout>
       <Head>
         
         <meta property="robots" content="noindex, follow"/>
+        <title>{pageTitle}</title>
       </Head>
 
       <div className="container margin-vert--lg">
@@ -91,9 +93,7 @@ export default function SearchPage() {
 function SearchResultItem({ searchResult: { document, type, page, tokens, metadata }, }) {
     const isTitle = type === 0;
     const isContent = type === 2;
-    const pathItems = (isTitle
-        ? document.b
-        : page.b).slice();
+    const pathItems = (isTitle ? document.b : page.b).slice();
     const articleTitle = (isContent ? document.s : document.t);
     if (!isTitle) {
         pathItems.push(page.t);
@@ -106,7 +106,9 @@ function SearchResultItem({ searchResult: { document, type, page, tokens, metada
             : highlightStemmed(articleTitle, getStemmedPositions(metadata, "t"), tokens, 100),
     }}></Link>
       </h2>
-      {pathItems.length > 0 && (<p className={styles.searchResultItemPath}>{pathItems.join(" › ")}</p>)}
+      {pathItems.length > 0 && (<p className={styles.searchResultItemPath}>
+          {concatDocumentPath(pathItems)}
+        </p>)}
       {isContent && (<p className={styles.searchResultItemSummary} dangerouslySetInnerHTML={{
         __html: highlightStemmed(document.t, getStemmedPositions(metadata, "t"), tokens, 100),
     }}/>)}

package/dist/client/client/utils/__mocks__/proxiedGenerated.js

@@ -3,15 +3,16 @@ export let removeDefaultStopWordFilter = false;
 export const indexHash = "abc";
 export const searchResultLimits = 8;
 export const searchResultContextMaxLength = 50;
+export const explicitSearchResultPath = false;
 export const translations = {
-    "search_placeholder": "Search",
-    "see_all_results": "See all results",
-    "no_results": "No results.",
-    "search_results_for": "Search results for \"{{ keyword }}\"",
-    "search_the_documentation": "Search the documentation",
-    "count_documents_found": "{{ count }} document found",
-    "count_documents_found_plural": "{{ count }} documents found",
-    "no_documents_were_found": "No documents were found"
+    search_placeholder: "Search",
+    see_all_results: "See all results",
+    no_results: "No results.",
+    search_results_for: 'Search results for "{{ keyword }}"',
+    search_the_documentation: "Search the documentation",
+    count_documents_found: "{{ count }} document found",
+    count_documents_found_plural: "{{ count }} documents found",
+    no_documents_were_found: "No documents were found",
 };
 export function __setLanguage(value) {
     language = value;

package/dist/client/client/utils/concatDocumentPath.js

@@ -0,0 +1,3 @@
+export function concatDocumentPath(pathItems) {
+    return pathItems.join(" › ");
+}

package/dist/server/server/utils/generate.js

@@ -6,7 +6,7 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const getIndexHash_1 = require("./getIndexHash");
 function generate(config, dir) {
-    const { language, removeDefaultStopWordFilter, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, translations, } = config;
+    const { language, removeDefaultStopWordFilter, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, translations, } = config;
     const indexHash = getIndexHash_1.getIndexHash(config);
     const contents = [
         `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
@@ -36,6 +36,7 @@ function generate(config, dir) {
     }
     contents.push(`export const indexHash = ${JSON.stringify(indexHash)};`);
     contents.push(`export const searchResultLimits = ${JSON.stringify(searchResultLimits)};`, `export const searchResultContextMaxLength = ${JSON.stringify(searchResultContextMaxLength)};`);
+    contents.push(`export const explicitSearchResultPath = ${JSON.stringify(explicitSearchResultPath)};`);
     contents.push(`export const translations = ${JSON.stringify(translations)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
 }

package/dist/server/server/utils/getIndexHash.js

@@ -22,7 +22,7 @@ function getIndexHash(config) {
                     console.warn(`Warn: \`${dirField}\` is not a directory: "${dir}".`);
                 }
                 else {
-                    files.push(...klaw_sync_1.default(dir, { nodir: true, filter: markdownFilter }));
+                    files.push(...klaw_sync_1.default(dir, { nodir: true, filter: markdownFilter, traverseAll: true }));
                 }
             }
         }
@@ -48,5 +48,5 @@ function getIndexHash(config) {
 }
 exports.getIndexHash = getIndexHash;
 function markdownFilter(item) {
-    return item.path.endsWith(".md");
+    return item.path.endsWith(".md") || item.path.endsWith(".mdx");
 }

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

@@ -4,7 +4,7 @@ exports.parseDocument = void 0;
 const getCondensedText_1 = require("./getCondensedText");
 const HEADINGS = "h1, h2, h3";
 function parseDocument($) {
-    const $pageTitle = $("article header h1").first();
+    const $pageTitle = $("article h1").first();
     const pageTitle = $pageTitle.text();
     const sections = [];
     const breadcrumb = [];

package/dist/server/server/utils/validateOptions.js

@@ -18,6 +18,7 @@ const schema = utils_validation_1.Joi.object({
     highlightSearchTermsOnTargetPage: utils_validation_1.Joi.boolean().default(false),
     searchResultLimits: utils_validation_1.Joi.number().default(8),
     searchResultContextMaxLength: utils_validation_1.Joi.number().default(50),
+    explicitSearchResultPath: utils_validation_1.Joi.boolean().default(false),
     ignoreFiles: isArrayOfStringsOrRegExpsOrStringOrRegExp.default([]),
     translations: utils_validation_1.Joi.object({
         search_placeholder: utils_validation_1.Joi.string().default("Search"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.23.0",
+  "version": "0.23.3",
   "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",
@@ -29,6 +29,7 @@
     "@docusaurus/utils": "^2.0.0-beta.4",
     "@docusaurus/utils-validation": "^2.0.0-beta.4",
     "@easyops-cn/autocomplete.js": "^0.38.1",
+    "@node-rs/jieba": "^1.6.0",
     "cheerio": "^1.0.0-rc.3",
     "clsx": "^1.1.1",
     "debug": "^4.2.0",
@@ -37,8 +38,7 @@
     "lunr": "^2.3.9",
     "lunr-languages": "^1.4.0",
     "mark.js": "^8.11.1",
-    "tslib": "^2.2.0",
-    "@node-rs/jieba": "^1.6.0"
+    "tslib": "^2.2.0"
   },
   "devDependencies": {
     "@babel/core": "^7.12.3",
@@ -47,6 +47,7 @@
     "@babel/preset-typescript": "^7.12.1",
     "@docusaurus/module-type-aliases": "^2.0.0-beta.4",
     "@tsconfig/docusaurus": "^1.0.2",
+    "@types/cheerio": "^0.22.31",
     "@types/debug": "^4.1.5",
     "@types/enzyme": "^3.10.7",
     "@types/enzyme-adapter-react-16": "^1.0.6",