centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Refactor search plugin (#1418)

Browse Source 
* Use a web worker in the browser with a fallback (fixes #859 & closes #1396).
* Optionally pre-build search index (fixes #859 & closes #1061).
* Upgrade to lunr.js 2.x (fixes #1319).
* Support search in languages other than English (fixes #826).
* Allow the user to define the word separators (fixes #867).
* Only run searches for queries of length > 2 (fixes #1127).
* Remove dependency on require.js, mustache, etc. (fixes #1218).
* Compress the search index (fixes #1128).
This commit is contained in:
Waylan Limberg
2018-03-05 19:42:20 -05:00
committed by GitHub
parent 0dce2b2b9e
commit dd7e2d910b
37 changed files with 11695 additions and 630 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/about/release-notes.md
View File

@@ -23,6 +23,30 @@ The current and past members of the MkDocs team.
## Development Version
### Major Additions to Development Version
#### Refactor Search Plugin
The search plugin has been completely refactored to include support for the
following features:
* Use a web worker in the browser with a fallback (#1396).
* Optionally pre-build search index locally (#859 & #1061).
* Upgrade to lunr.js 2.x (#1319).
* Support search in languages other than English (#826).
* Allow the user to define the word separators (#867).
* Only run searches for queries of length > 2 (#1127).
* Remove dependency on require.js (#1218).
* Compress the search index (#1128).
Users can review the [configuration options][search config] available and theme
authors should review how [search and themes] interact.
[search config]: ../user-guide/configuration.md#search
[search and themes]: ../user-guide/custom-themes.md#search_and_themes
### Other Changes and Additions to Development Version
* Expand {sha} and {version} in gh-deploy commit message (#1410).
* Compress `sitemap.xml` (#1130).
* Defer loading JS scripts (#1380).