OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deprecated prebuilding of search index

Browse Source
This commit is contained in:
squidfunk 2021-10-02 15:53:47 +02:00
parent aaba4cb3db
commit eb4afa0540
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/setup/setting-up-site-search.md
View File

@ -111,10 +111,10 @@ The following options are supported:
separator: '[\s\-\.]+' separator: '[\s\-\.]+'
``` ```
`prebuild_index`{ #prebuild-index } ~~`prebuild_index`~~{ #prebuild-index }[^1]
: :octicons-milestone-24: Default: `false` · :octicons-beaker-24: : :octicons-milestone-24: Default: `false` · :octicons-archive-24: Deprecated
Experimental – MkDocs can generate a [prebuilt index][7] of all pages during – MkDocs can generate a [prebuilt index][7] of all pages during
build time, which provides performance improvements at the cost of more build time, which provides performance improvements at the cost of more
bandwidth, as it reduces the build time of the search index: bandwidth, as it reduces the build time of the search index:
@ -123,11 +123,16 @@ The following options are supported:
- search: - search:
prebuild_index: true prebuild_index: true
``` ```
This may be beneficial for large documentation projects served with This may be beneficial for large documentation projects served with
appropriate headers, i.e. `Content-Encoding: gzip`, but benchmarking before appropriate headers, i.e. `Content-Encoding: gzip`, but benchmarking before
deployment is recommended. deployment is recommended.
[^1]:
The `prebuild_index` feature was deprecated in 7.3.0 and will be removed
in 8.x. Insiders removed support in 3.0.0 with the advent of the new
search plugin.
_Material for MkDocs doesn't provide official support for the other options of _Material for MkDocs doesn't provide official support for the other options of
this plugin, so they may be supported but might yield unexpected results. this plugin, so they may be supported but might yield unexpected results.
Use them at your own risk._ Use them at your own risk._