File tree 1 file changed +9
-4
lines changed
1 file changed +9
-4
lines changed Original file line number Diff line number Diff line change @@ -111,10 +111,10 @@ The following options are supported:
111
111
separator: '[\s\-\. ]+'
112
112
` ` `
113
113
114
- ` prebuild_index` { # prebuild-index }
114
+ ~~ `prebuild_index`~~ { # prebuild-index }[^1]
115
115
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
118
118
build time, which provides performance improvements at the cost of more
119
119
bandwidth, as it reduces the build time of the search index :
120
120
@@ -123,11 +123,16 @@ The following options are supported:
123
123
- search:
124
124
prebuild_index: true
125
125
` ` `
126
-
126
+
127
127
This may be beneficial for large documentation projects served with
128
128
appropriate headers, i.e. `Content-Encoding : gzip`, but benchmarking before
129
129
deployment is recommended.
130
130
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
+
131
136
_Material for MkDocs doesn't provide official support for the other options of
132
137
this plugin, so they may be supported but might yield unexpected results.
133
138
Use them at your own risk._
You can’t perform that action at this time.
0 commit comments