docusaurus-search-local

Offline / Local Search for Docusaurus v2. Try it live at:

MIT License

Downloads
98.7K
Stars
438
Committers
29

Bot releases are visible (Hide)

docusaurus-search-local - v1.2.0 Latest Release

Published by cmfcmf 4 months ago

Note: This version is not yet compatible with Docusaurus v3. Please follow https://github.com/cmfcmf/docusaurus-search-local/issues/205 for updates.

Features

docusaurus-search-local -

Published by cmfcmf over 1 year ago

Features

Bug Fixes

  • Re-add support for using this plugin on Windows (0337ada), closes #175 #179
docusaurus-search-local -

Published by cmfcmf over 1 year ago

⚠ BREAKING CHANGES

  • The minimum supported Docusaurus version is now v2.0.0.

Features

Bug Fixes

  • Correctly extract page titles when not specified in frontmatter, closes #146 (1f33151)
  • Do not generate .d.ts files, which break docusaurus write-translations, closes #145, #129, #163, #167 (c09cc94)
  • Fix potential error when calculating paths, closes #136 (26f1b71)
  • Resolve warning regarding render parameter in autocomplete, closes #148 (66d41e4)
  • Support Yarn pnp, closes #139 (045d534)

Other

  • Update to Docusaurus v2 (f8619b7)
docusaurus-search-local - v0.11.0

Published by cmfcmf over 2 years ago

0.11.0 (2022-06-12)

Bug Fixes

  • Correct alignment of search input, closes #117 (f29dc02)

chore

Features

BREAKING CHANGES

  • The default height of the search input is now 36px. Use
    the --aa-search-input-height CSS variable to adjust it if needed.
  • The minimum supported Docusaurus version is now v2.0.0-beta21
  • the minimum supported Docusaurus version is now v2.0.0-beta17.
docusaurus-search-local - v0.10.0

Published by cmfcmf over 2 years ago

0.10.0 (2022-01-28)

Features

  • Add polish translations 🇵🇱 (#95) (e947ad1)
  • support Docusaurus v2.0.0-beta.15, fixes #93 (30a6c66)

BREAKING CHANGES

  • the minimum supported Docusaurus version is now v2.0.0-beta15.
docusaurus-search-local - v0.9.4

Published by cmfcmf over 2 years ago

0.9.4 (2022-01-19)

Bug Fixes

  • Return EMPTY_INDEX when server responds with error. (#91) (1a4d89c)
docusaurus-search-local - v0.9.3

Published by cmfcmf almost 3 years ago

0.9.3 (2022-01-13)

Bug Fixes

  • wrong variable when checking available documentation plugins (8b04bbf)
docusaurus-search-local - v0.9.2

Published by cmfcmf almost 3 years ago

0.9.2 (2021-12-14)

Bug Fixes

  • support trailingSlash = false (371d60a), closes #52
docusaurus-search-local - v0.9.1

Published by cmfcmf almost 3 years ago

0.9.1 (2021-12-14)

Bug Fixes

  • do not throw error if a search index does not exist (9a17de6), closes #85

Features

  • update @algolia/autocomplete-js to 1.5.1 (5631755)
docusaurus-search-local - v0.9.0

Published by cmfcmf almost 3 years ago

0.9.0 (2021-12-11)

Features

  • split indexes by plugin and documentation versions (2953045)
  • support up to Docusaurus v2.0.0-beta13 (e74750f), closes #82 #83

BREAKING CHANGES

  • the minimum supported Docusaurus version is now v2.0.0-beta9.
docusaurus-search-local -

Published by cmfcmf almost 3 years ago

  • FEAT: Support multiple docs, blogs, and pages plugins (#33)
docusaurus-search-local -

Published by cmfcmf almost 3 years ago

  • FEAT: Infer docsPath, docsRouteBasePath, and blogRouteBasePath from Docusaurus context
  • FEAT: Make similarity tuning parameters and boosting behavior of title vs content vs parent categories configurable (#67)
  • FEAT: Align documentation version detection with DocsVersionNavbarItem
  • FIX: Correctly exclude tags pages of both docs and blogs, respect tagsBasePath if configured
  • BREAKING: Now requires Docusaurus v2.0.0-beta4 or later
  • BREAKING: Now requires at least Node.js 14
  • CLEANUP: Reorganize repository layout, use yarn workspaces
docusaurus-search-local -

Published by cmfcmf about 3 years ago

  • FEAT: Support Docusaurus v2.0.0-beta5
docusaurus-search-local -

Published by cmfcmf about 3 years ago

  • FEAT: Add additional translations of autocomplete (Spanish, French, Japanese, and Portugese) (#56)
docusaurus-search-local -

Published by cmfcmf about 3 years ago

  • FIX: Re-add support for Chinese (zh)
docusaurus-search-local -

Published by cmfcmf about 3 years ago

  • FIX: Correctly handle trailingSlash config option (#52)
  • FEAT: Fully localized autocomplete (currently in German, English, Italian, Brazilian Portuguese, and Chinese), update autocomplete to 1.2.2
  • FEAT: Support Hindi for search indexing (hi)
  • FEAT: Validate plugin options (#46)
docusaurus-search-local -

Published by cmfcmf over 3 years ago

  • FEAT: Italian translations
  • FIX: Missing peer dependency warnings
  • FIX: Correct Docusaurus peer dependency version (#36)
  • BREAKING: Now requires Docusaurus v2.0.0-beta0
docusaurus-search-local -

Published by cmfcmf over 3 years ago

  • FIX: Add missing codeTranslations folder to release package
docusaurus-search-local -

Published by cmfcmf over 3 years ago

  • BREAKING: Now requires Docusaurus v2.0.0-alpha73
  • BREAKING: Update autocomplete.js to v1-alpha, which features an all-new design and renamed class names (#32).
  • FEAT: Use i18n system for translation of the searchbar itself, translate to German and English (#29)
    • BREAKING: To specfiy a non-default placeholder if no results are found, overwrite the newly introduced translation keys instead of .d-s-l-a .aa-dropdown-menu .aa-suggestion-empty::after { content: "No results"; }
  • FEAT: Yellow result higlighting no longer adds a parameter to the URL and vanishes on refresh (#28)
  • FIX: Support for language th

preview

docusaurus-search-local -

Published by cmfcmf almost 4 years ago

  • FIX: Correctly handle "/" as docsRouteBasePath and blogRouteBasePath (#21)
  • FIX: Exclude hash link "#" from HTML headings when indexing
  • FIX: Use same tokenizer that was used for indexing documents to tokenize the content of the search box
  • FEAT: Allow to specify a different separator for the tokenizer (#20)
  • FEAT: Find blog posts and static pages regardless of the currently selected documentation version (#19)
  • FEAT: For docs, optionally also index the titles of parent categories in the sidebar (#17)