From eb4afa0540e47c11e5dc872f66d383d6e5ccce2b Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 2 Oct 2021 15:53:47 +0200 Subject: [PATCH] Deprecated prebuilding of search index --- docs/setup/setting-up-site-search.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index a366cb604..d77761ab9 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -111,10 +111,10 @@ The following options are supported: separator: '[\s\-\.]+' ``` -`prebuild_index`{ #prebuild-index } +~~`prebuild_index`~~{ #prebuild-index }[^1] -: :octicons-milestone-24: Default: `false` · :octicons-beaker-24: - Experimental – MkDocs can generate a [prebuilt index][7] of all pages during +: :octicons-milestone-24: Default: `false` · :octicons-archive-24: Deprecated + – MkDocs can generate a [prebuilt index][7] of all pages during build time, which provides performance improvements at the cost of more bandwidth, as it reduces the build time of the search index: @@ -123,11 +123,16 @@ The following options are supported: - search: prebuild_index: true ``` - + This may be beneficial for large documentation projects served with appropriate headers, i.e. `Content-Encoding: gzip`, but benchmarking before 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 this plugin, so they may be supported but might yield unexpected results. Use them at your own risk._