Skip to content

Latest commit

 

History

History
254 lines (158 loc) · 12.9 KB

CHANGELOG.md

File metadata and controls

254 lines (158 loc) · 12.9 KB
Raw

Change Log

All notable changes to this project will be documented in this file. This change log is automatically generated based on commit messags. See Commit Message Guidelines for more information.

1.1.0 (2023-04-10)

Features

Bug Fixes

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

1.0.0 (2023-02-26)

⚠ 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)

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.

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.

0.9.4 (2022-01-19)

Bug Fixes

  • Return EMPTY_INDEX when server responds with error. (#91) (1a4d89c)

0.9.3 (2022-01-13)

Bug Fixes

  • wrong variable when checking available documentation plugins (8b04bbf)

0.9.2 (2021-12-14)

Bug Fixes

  • support trailingSlash = false (371d60a), closes #52

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)

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.

0.8.0

  • FEAT: Support multiple docs, blogs, and pages plugins (#33)

0.7.0

  • 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

0.6.7

  • FEAT: Add support for Bahasa Indonesia (id)
  • FEAT: Support Docusaurus v2.0.0-beta7

0.6.6

  • FEAT: Support Docusaurus v2.0.0-beta5

0.6.5

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

0.6.4

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

0.6.3

  • 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)

0.6.2

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

0.6.1

  • FIX: Add missing codeTranslations folder to release package

0.6.0

  • 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

0.5.0

  • 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)

0.4.0

  • BREAKING: Now requires Docusaurus v2.0.0-alpha66
  • FEAT: Upgrade to new version APIs from v2.0.0-alpha66

0.3.1

  • FIX: Search did not work in Safari (#18)

0.3.0

  • FEAT: Support versioned documentation
  • BREAKING: Renamed options
    • blogBasePath to blogRouteBasePath
    • docsBasePath to docsRouteBasePath
  • BREAKING: Now requires Docusaurus v2.0.0-alpha.59
  • FIX: Remove version badge from search index
  • FIX: Correct docs/blog/page detection logic for edge cases (e.g., /docs-foo-bar is no longer considered a documentation page)
  • FIX: Use correct plugin name
  • FIX: Japanese and Thai search should now work correctly (#12)

0.2.0

  • FEAT: Highlight search results on the page using a new highlight query parameter

0.1.3

  • FIX: <style> and <script> tags no longer break indexing (#7)

0.1.2

  • FEAT: Make search results easier to style, improve markup (#6)

0.1.1

  • FIX: Parsing of empty sections and pages
  • FIX: Parsing static pages was broken
  • FEAT: Add logging

0.1.0

  • FEAT: Support for indexing other languages than English (#3)
  • FEAT: New options to configure indexing.
  • FIX: Navigation buttons are no longer included in indexed text (#4).
  • BREAKING: Static pages are no longer indexed by default

0.0.5

  • FIX: Set different dropdown colors in dark theme.

0.0.4

  • FIX: Focus search bar after loading the index if it was previously focused.
  • FEAT: Introduce document ids to make index smaller

0.0.3

  • FIX: Lowercase all search terms before searching the index. A search term with an uppercase letter never gives any results, because the index is all lowercase.
  • FEAT: If document and section titles are equal, only display one of them in search results.

0.0.2

  • FIX: Prepend baseUrl when fetching search index.
  • FEAT: Add more fields to package.json.

0.0.1

  • Initial version