Skip to content

Commit eb4afa0

Browse files
committed
Deprecated prebuilding of search index
1 parent aaba4cb commit eb4afa0

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

Diff for: docs/setup/setting-up-site-search.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,10 @@ The following options are supported:
111111
separator: '[\s\-\.]+'
112112
```
113113

114-
`prebuild_index`{ #prebuild-index }
114+
~~`prebuild_index`~~{ #prebuild-index }[^1]
115115

116-
: :octicons-milestone-24: Default: `false` · :octicons-beaker-24:
117-
Experimental – MkDocs can generate a [prebuilt index][7] of all pages during
116+
: :octicons-milestone-24: Default: `false` · :octicons-archive-24: Deprecated
117+
– MkDocs can generate a [prebuilt index][7] of all pages during
118118
build time, which provides performance improvements at the cost of more
119119
bandwidth, as it reduces the build time of the search index:
120120

@@ -123,11 +123,16 @@ The following options are supported:
123123
- search:
124124
prebuild_index: true
125125
```
126-
126+
127127
This may be beneficial for large documentation projects served with
128128
appropriate headers, i.e. `Content-Encoding: gzip`, but benchmarking before
129129
deployment is recommended.
130130

131+
[^1]:
132+
The `prebuild_index` feature was deprecated in 7.3.0 and will be removed
133+
in 8.x. Insiders removed support in 3.0.0 with the advent of the new
134+
search plugin.
135+
131136
_Material for MkDocs doesn't provide official support for the other options of
132137
this plugin, so they may be supported but might yield unexpected results.
133138
Use them at your own risk._

0 commit comments

Comments
 (0)