CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.44.5 (2024-08-12)

Bug Fixes

• update cheerio to 1.0.0, closes #444 (0d70f63)

0.44.4 (2024-07-19)

Bug Fixes

• do not initialize lunr multiple times, fixes #155 (0b323d9)

0.44.3 (2024-07-08)

Bug Fixes

• append a / to the search link. (#432) (60c23d4)

0.44.2 (2024-06-20)

Bug Fixes

• manually make the search bar be LTR even if in RTL (a5c7184)

0.44.1 (2024-06-19)

Bug Fixes

• fix searching within context closes #424 (bbec667)

0.44.0 (2024-06-06)

Features

• add more translate to locales (#417) (0ee814b)

0.43.0 (2024-06-05)

Features

• add theme.SearchPage.searchContext.everywhere to locales (#414) (5e13bda)

0.42.0 (2024-06-04)

Features

• support add document to multiple context paths (#412), closes #407 (0107676)

0.41.1 (2024-06-04)

Bug Fixes

• bump version only for handling hash link with url path, closes #408 via #410 (9d76b81)

0.41.0 (2024-05-23)

Features

• support search based on description and keywords (0c12b59), closes #344

0.40.1 (2023-12-23)

Bug Fixes

• fix search page no results, closes #389 (64e26c2)

0.40.0 (2023-12-19)

Features

• allow force enable search index even if noIndex: true is set (09d0f30), closes #385
• support i18n for search context labels (83b05a2)

0.39.0 (2023-12-15)

Features

• customize search context labels #382 (f7df7bb)

0.38.1 (2023-11-28)

Bug Fixes

• compile to commonjs (b8dc37d), closes #370

0.38.0 (2023-11-24)

Features

• do not index unlisted content (b0c425d), closes #371

0.37.5 (2023-11-24)

Bug Fixes

• set typescript target back to ES6 (c05151f)

0.37.4 (2023-11-12)

Bug Fixes

• fix peer deps of react 16/17/18 (700d640)

0.37.3 (2023-11-12)

Bug Fixes

• fix SSR warning, closes #364 (69378e6)

0.37.2 (2023-11-09)

Bug Fixes

• support both Docusaurus v2 and v3 (89bd0f5)

0.37.1 (2023-11-09)

Bug Fixes

• update readme and fix release workflow (e11ad12)

0.37.0 (2023-11-09)

Features

• support docusaurus v3 (18c01c2)

0.36.0 (2023-09-09)

Features

• added ignoreClasses option to be able to exclude specific content from indexing (e9f7794)

Bug Fixes

• make tests work on windows (565199a)

0.35.0 (2023-03-04)

Features

• improve no results UI when searching in context (#323) (1a70835)

0.34.0 (2023-02-16)

Features

• improve search context feature #319 (a9578cc)

0.33.6 (2022-11-28)

Bug Fixes

• use key instead of code for keyboard events (5e919f4), closes #298

0.33.5 (2022-10-24)

Bug Fixes

• fix see all results with non-ascii chars (18b5a16)

0.33.4 (2022-10-18)

Bug Fixes

• refine version in search page (6d091b7)

0.33.3 (2022-10-18)

Bug Fixes

• pass version instead of detect version in search page (8ca32f0), closes #285

0.33.2 (2022-10-17)

Bug Fixes

• fix search terms highlighting (aacc610), closes #266

0.33.1 (2022-10-17)

Bug Fixes

• refine search context, support hideSearchBarWithNoSearchContext (38908ed)

0.33.0 (2022-10-16)

Features

• support search context by paths (aa6de9a)

0.32.1 (2022-10-08)

Bug Fixes

• fix indexing when trailingSlash is explicitly set (cfc603d)

0.32.0 (2022-09-05)

Features

• support setting searchBarPosition (60b27d4), closes #263

0.31.0 (2022-08-08)

Features

• support zhUserDict and zhUserDictPath (33f1ea4), closes #246

0.30.2 (2022-07-23)

Bug Fixes

• remove useDocsPreferredVersion error log entirely (56f5ab5)
• use debug instead of console.error for useDocsPreferredVersion message (3a09e39)

0.30.1 (2022-07-22)

Bug Fixes

• fix building error when docs disabled (07b1724)

0.30.0 (2022-07-22)

Features

• support saving hash in filename instead of query (4930a88), closes #171

0.29.4 (2022-07-22)

Bug Fixes

• fix call stack overflow with large code blocks (e0b2cfd), closes #164

0.29.3 (2022-07-20)

Bug Fixes

• hide clear button on small screen when input is not focused (c69fbf6), closes #230

0.29.2 (2022-07-19)

Bug Fixes

• fix website with docs multi-instance (f61304e), closes #211

0.29.1 (2022-07-19)

Bug Fixes

• require docusaurus v2.0.0-rc.1 (41a4e67)
• add hack for useDocsPreferredVersion crash in SearchPage (02fdc42)
• fix error when not using versions (f11293f)

0.29.0 (2022-07-07)

Features

• support disabling search bar shortcut (e0ea5ae)
• support hiding search bar shortcut hint (9344bd2)

0.28.0 (2022-06-28)

Features

• add locales/vi.json (#217) (26f9a2a)

0.27.2 (2022-06-21)

Bug Fixes

• search page for non latest doc versions (15f6161)
• use the active plugin id when getting the current docs version (824e134)
• fix active plugin may be undefined (0bfbbb2)
• make @docusaurus/theme-common as peer (68dc812)

0.27.1 (2022-06-13)

Bug Fixes

• properly support no trailing slashes after fixing indexing top level pages (999bd8b), closes #212

0.27.0 (2022-05-29)

Features

• versioned search (6865e7c), closes #66

0.26.1 (2022-05-25)

Bug Fixes

• fix i18n id of theme.SearchPage.noResultsText (fe530f3)

0.26.0 (2022-05-24)

Features

• add a clear button to the search bar #170 (f516123)

0.25.0 (2022-05-19)

⚠ BREAKING CHANGES

• drop translations in options

Features

• on board docusaurus i18n system (70868c3), closes #160

0.24.1 (2022-05-19)

Bug Fixes

• fix indexing content between h1 and h2 (f38b307)

0.24.0 (2022-05-18)

Features

• Add option to disable the default lunr stemmer (ff8e9a2)

Bug Fixes

• deps: update dependency fs-extra to v10 (96c9220)
• Fix parsing of top level pages when using docs only mode (ff8e9a2)
• Fix passing of top sections for versions of docusaurus with breadcrumbs (ff8e9a2)
• Fix search term highlighting when reusing the same search string (ff8e9a2)

0.23.3 (2022-05-18)

Bug Fixes

• Update getIndexHash.ts to support mdx and traverseAll (#172) (717942e)

0.23.2 (2022-04-25)

Bug Fixes

• install cheerio types (0a45f41)

0.23.1 (2022-04-07)

Bug Fixes

• parse h1 from the whole article (aeb063a)

0.23.0 (2022-03-10)

Features

• replace nodejieba with @node-rs/jieba (f3f7594)

0.22.0 (2022-02-28)

Features

• improve focus for search bar (e4ede16)

0.21.4 (2021-12-15)

Bug Fixes

• set max-width for dropdown on small screen (cec8c39), closes #135

0.21.3 (2021-12-14)

Bug Fixes

• use keydown instead of keypress (d871f0b), closes #132

0.21.2 (2021-12-13)

Bug Fixes

• refine styles with dark navbar (e3c9eef), closes #128

0.21.1 (2021-12-07)

Bug Fixes

• fix input box style of search page in dark mode (f233bce), closes #125

0.21.0 (2021-12-04)

Features

• add shortcut (cmd/ctrl + K) support (f12403f)

0.20.0 (2021-11-12)

Features

• remove nodejieba from peerDependencies (e76bb64)

0.19.1 (2021-08-03)

Bug Fixes

• fix docsRouteBasePath or blogRouteBasePath set to "/" (a1b1df6)
• fix search page ignore (9841cc8)
• refine get site config (e215a1a)

0.19.0 (2021-08-03)

Features

• depends on docusaurus 2.0.0-beta.4 (69ea575)

Bug Fixes

• handle trailingSlash config (16aa10f), closes #100

0.18.1 (2021-06-05)

Bug Fixes

• fix an issue of highlighting in code blocks (3378b9c), closes #92

0.18.0 (2021-06-05)

Features

• support docusaurus 2.0.0-beta.0 (a144b7f)

0.17.0 (2021-05-28)

Features

• ignore search files by config (#88) (a7b1b3a)

0.16.3 (2021-05-13)

Bug Fixes

• missing runtime dependency tslib (2f9d553)

Miscellaneous Chores

• release 0.16.3 (b99a906)

0.16.2 (2021-05-08)

Bug Fixes

• support webpack v5 since docusaurus v2 alpha 75 (5d1810b), closes #81

0.16.1 (2021-04-21)

Bug Fixes

• fix search bar error with new docusaurus (ed5db80), closes #77

0.16.0 (2021-04-20)

⚠ BREAKING CHANGES

• requires docusaurus ^2.0.0-alpha.73

Features

• fix error of mixing of joi schemas (2159902), closes #31

0.15.1 (2021-04-08)

Bug Fixes

• remove form from search page (f208313), closes #64

0.15.0 (2021-03-06)

Features

• support translations in plugin options (c6dc344), closes #59

0.14.4 (2021-01-12)

Bug Fixes

• fix release-please workflow (e823a8f)

0.14.3 (2021-01-12)

Bug Fixes

• fix highlight not cleared when researching (37a1a10)

0.14.2 (2020-11-25)

Bug Fixes

• fix trailing hash not trimmed after upgraded docusaurus v2.0.0-alpha.69 (2750ef6)

0.14.1 (2020-11-19)

Bug Fixes

• fix search bar loading style (59464c4)

0.14.0 (2020-11-19)

Features

• compatible with docusaurus v2.0.0-alhpa.68
• migrate from @hapi/joi to joi after upgraded docusaurus v2 alpha.68 (e33ce5b), closes #31

0.13.1 (2020-11-17)

Bug Fixes

• fix missing hash in search page links (8f1b889)

0.13.0 (2020-11-14)

Features

• add an opt-in option highlightSearchTermsOnTargetPage (e6621e8)

0.12.0 (2020-11-14)

Features

• support multiple docs and blog folders #24 (d90f4ad)

0.11.2 (2020-11-05)

Bug Fixes

• fix errors in development mode (2331b73)
• show tips in search page in development mode (4666bee)

0.11.1 (2020-11-02)

Bug Fixes

• remove debug flag (7238af2)

0.11.0 (2020-11-01)

Features

• search page to view all results (0495e71)

0.10.1 (2020-10-30)

Bug Fixes

• process stop words for search keyword (df3d789)

0.10.0 (2020-10-29)

Features

• show loading status (853603a)

0.9.4 (2020-10-29)

Bug Fixes

• refine index hash (7551266)

0.9.3 (2020-10-29)

Bug Fixes

• fix languages other than en and zh (f43fd4b), closes #9

0.9.2 (2020-10-24)

Bug Fixes

• refine debug (554c451)

0.9.1 (2020-10-24)

Bug Fixes

• check dir before create content hash (faf9cf7)

0.9.0 (2020-10-23)

Features

• add a plugin option searchResultLimits (0bdec39)
• add a plugin option of searchResultContextMaxLength (3313552)
• validate options using Joi (0b1361a)

0.8.0 (2020-10-21)

⚠ BREAKING CHANGES

• renamed docsBasePath and blogBasePath to docsRouteBasePath and blogRouteBasePath, to keep them the same as cmfcmf/docusaurus-search-local.
• users need to install nodejieba if using language of zh.

Features

• make nodejieba as a peer dependency (956b3b5)
• rename option of *BasePath (978846a)

Bug Fixes

• fix nodejieba is still required (78e4d67)
• fix styles on mobile screen (1cc6850)
• languages of non-en require stemmer support (bc8e451)

0.7.1 (2020-10-21)

Bug Fixes

• fix nodejieba is still required (78e4d67)

0.7.0 (2020-10-21)

⚠ BREAKING CHANGES

• users need to install nodejieba if using language of zh.

Features

• make nodejieba as a peer dependency (956b3b5)

0.6.2 (2020-10-21)

Bug Fixes

• fix styles on mobile screen (1cc6850)

0.6.1 (2020-10-21)

Bug Fixes

• languages of non-en require stemmer support (bc8e451)

0.6.0 (2020-10-20)

⚠ BREAKING CHANGES

• css already included.

Features

• plugin options refined (b722878)
• shipped with css (af0d7b0)

0.5.3 (2020-10-20)

Features

• plugin options refined (b722878)

0.5.2 (2020-10-18)

Bug Fixes

• fix consecutive Chinese words are not matched (db8541e)

0.5.1 (2020-10-18)