Skip to content

Commit 6fab1e3

Browse files
committed
Fixed buggy content tabs overflow scrolling + updated documentation
1 parent c4cf616 commit 6fab1e3

File tree

8 files changed

+325
-321
lines changed

8 files changed

+325
-321
lines changed

docs/changelog/index.md

+211-211
Large diffs are not rendered by default.

docs/insiders/changelog.md

+57-57
Original file line numberDiff line numberDiff line change
@@ -6,264 +6,264 @@ template: overrides/main.html
66

77
## Material for MkDocs Insiders
88

9-
### 3.1.2 <small>_ October 6, 2021</small>
9+
### 3.1.2 <small>_ October 6, 2021</small> { id="3.1.2" }
1010

1111
- Fixed incorrect path separators for social cards on Windows
1212

13-
### 3.1.1 <small>_ September 26, 2021</small>
13+
### 3.1.1 <small>_ September 26, 2021</small> { id="3.1.1" }
1414

1515
- Fixed ordering bug in search exclusion logic
1616

17-
### 3.1.0 <small>_ September 26, 2021</small>
17+
### 3.1.0 <small>_ September 26, 2021</small> { id="3.1.0" }
1818

1919
- Added support for excluding pages, sections, and elements from search
2020
- Fixed #2803: Code block annotations not visible when printing
2121

22-
### 3.0.1 <small>_ September 19, 2021</small>
22+
### 3.0.1 <small>_ September 19, 2021</small> { id="3.0.1" }
2323

2424
- Added support for using literal `h1-6` tags for search plugin
2525
- Fixed search plugin breaking on void elements without slashes
2626
- Fixed search plugin filtering link contents from headlines
2727
- Fixed search plugin handling of multiple `h1` headlines
2828
- Fixed search plugin handling of missing `h1` headlines
2929

30-
### 3.0.0 <small>_ September 13, 2021</small>
30+
### 3.0.0 <small>_ September 13, 2021</small> { id="3.0.0" }
3131

3232
- Rewrite of MkDocs' search plugin
3333
- Added support for rich search previews
3434
- Added support for tokenizer with lookahead
3535
- Improved search indexing performance (twice as fast)
3636
- Improved search highlighting
3737

38-
### 2.13.3 <small>_ September 1, 2021</small>
38+
### 2.13.3 <small>_ September 1, 2021</small> { id="2.13.3" }
3939

4040
- Added support for disabling social card generation
4141

42-
### 2.13.2 <small>_ August 25, 2021</small>
42+
### 2.13.2 <small>_ August 25, 2021</small> { id="2.13.2" }
4343

4444
- Fixed #2965: Social plugin error when primary color is not defined
4545

46-
### 2.13.1 <small>_ August 21, 2021</small>
46+
### 2.13.1 <small>_ August 21, 2021</small> { id="2.13.1" }
4747

4848
- Fixed #2948: Social cards are not cached
4949
- Fixed #2953: Mermaid.js diagrams can't be centered anymore
5050

51-
### 2.13.0 <small>_ August 7, 2021</small>
51+
### 2.13.0 <small>_ August 7, 2021</small> { id="2.13.0" }
5252

5353
- Added support for custom colors in social cards
5454

55-
### 2.12.2 <small>_ August 4, 2021</small>
55+
### 2.12.2 <small>_ August 4, 2021</small> { id="2.12.2" }
5656

5757
- Fixed #2891: Division by zero error in social plugin
5858

59-
### 2.12.1 <small>_ July 26, 2021</small>
59+
### 2.12.1 <small>_ July 26, 2021</small> { id="2.12.1" }
6060

6161
- Fixed error in social plugin when `site_description` was not set
6262
- Fixed error in social plugin for non-ASCII characters
6363

64-
### 2.12.0 <small>_ July 25, 2021</small>
64+
### 2.12.0 <small>_ July 25, 2021</small> { id="2.12.0" }
6565

6666
- Added support for social cards
6767

68-
### 2.11.1 <small>_ July 20, 2021</small>
68+
### 2.11.1 <small>_ July 20, 2021</small> { id="2.11.1" }
6969

7070
- Fixed order of tags index, now sorted alphabetically
7171

72-
### 2.11.0 <small>_ July 18, 2021</small>
72+
### 2.11.0 <small>_ July 18, 2021</small> { id="2.11.0" }
7373

7474
- Improved Mermaid.js intergration, now stable
7575
- Added support for sequence diagrams
7676
- Added support for entity relationship diagrams
7777
- Added support for cookie consent configuration
7878
- Added feature flag to always enable annotations
7979

80-
### 2.10.0 <small>_ July 10, 2021</small>
80+
### 2.10.0 <small>_ July 10, 2021</small> { id="2.10.0" }
8181

8282
- Added support for cookie consent
8383
- Fixed #2807: Back-to-top button not hidden when using sticky tabs
8484

85-
### 2.9.2 <small>_ May 30, 2021</small>
85+
### 2.9.2 <small>_ May 30, 2021</small> { id="2.9.2" }
8686

8787
- Moved tags to partial for easier customization
8888
- Added support for hiding tags on any page
8989

90-
### 2.9.1 <small>_ May 24, 2021</small>
90+
### 2.9.1 <small>_ May 24, 2021</small> { id="2.9.1" }
9191

9292
- Added missing guard for linking of content tabs
9393

94-
### 2.9.0 <small>_ May 23, 2021</small>
94+
### 2.9.0 <small>_ May 23, 2021</small> { id="2.9.0" }
9595

9696
- Added support for linking of content tabs
9797

98-
### 2.8.0 <small>_ May 12, 2021</small>
98+
### 2.8.0 <small>_ May 12, 2021</small> { id="2.8.0" }
9999

100100
- Added support for boosting pages in search
101101

102-
### 2.7.2 <small>_ May 8, 2021</small>
102+
### 2.7.2 <small>_ May 8, 2021</small> { id="2.7.2" }
103103

104104
- Fixed #2638: Warnings shown when using `tags` plugin without directory URLs
105105

106-
### 2.7.1 <small>_ May 3, 2021</small>
106+
### 2.7.1 <small>_ May 3, 2021</small> { id="2.7.1" }
107107

108108
- Fixed `git-revision-date-localized` plugin integration (2.7.0 regression)
109109

110-
### 2.7.0 <small>_ May 1, 2021</small>
110+
### 2.7.0 <small>_ May 1, 2021</small> { id="2.7.0" }
111111

112112
- Added support for tags (with search integration)
113113

114-
### 2.6.0 <small>_ April 11, 2021</small>
114+
### 2.6.0 <small>_ April 11, 2021</small> { id="2.6.0" }
115115

116116
- Stay on page when switching versions
117117

118-
### 2.5.0 <small>_ March 28, 2021</small>
118+
### 2.5.0 <small>_ March 28, 2021</small> { id="2.5.0" }
119119

120120
- Added support for version warning
121121

122-
### 2.4.0 <small>_ March 20, 2021</small>
122+
### 2.4.0 <small>_ March 20, 2021</small> { id="2.4.0" }
123123

124124
- Added support for custom admonition icons
125125
- Fixed #2444: Code block annotations with extra comments have wrong index
126126

127-
### 2.3.1 <small>_ March 14, 2021</small>
127+
### 2.3.1 <small>_ March 14, 2021</small> { id="2.3.1" }
128128

129129
- Fixed anchor offset for permalinks when using sticky navigation tabs
130130

131-
### 2.3.0 <small>_ March 13, 2021</small>
131+
### 2.3.0 <small>_ March 13, 2021</small> { id="2.3.0" }
132132

133133
- Added support for back-to-top button
134134

135-
### 2.2.1 <small>_ March 4, 2021</small>
135+
### 2.2.1 <small>_ March 4, 2021</small> { id="2.2.1" }
136136

137137
- Fixed #2382: Repository stats failing when no release tag is present
138138

139-
### 2.2.0 <small>_ February 28, 2021</small>
139+
### 2.2.0 <small>_ February 28, 2021</small> { id="2.2.0" }
140140

141141
- Added support for code block annotations
142142

143-
### 2.1.0 <small>_ February 26, 2021</small>
143+
### 2.1.0 <small>_ February 26, 2021</small> { id="2.1.0" }
144144

145145
- Added support for anchor tracking
146146

147-
### 2.0.0 <small>_ February 24, 2021</small>
147+
### 2.0.0 <small>_ February 24, 2021</small> { id="2.0.0" }
148148

149149
- Migrated Insiders to the new architecture
150150
- Swapped color palette toggle configuration
151151

152-
### 1.17.0 <small>_ January 31, 2021</small>
152+
### 1.17.0 <small>_ January 31, 2021</small> { id="1.17.0" }
153153

154154
- Added support for section index pages
155155

156-
### 1.16.1 <small>_ January 26, 2021</small>
156+
### 1.16.1 <small>_ January 26, 2021</small> { id="1.16.1" }
157157

158158
- Fixed #2249: Instant loading + sticky tabs result in invalid links
159159
- Fixed #2248: Search highlighting URL parameter always added
160160
- Fixed #2235: Version selector doesn't select current version for aliases
161161

162-
### 1.16.0 <small>_ January 7, 2021</small>
162+
### 1.16.0 <small>_ January 7, 2021</small> { id="1.16.0" }
163163

164164
- Added latest release to repository info (GitHub)
165165
- Slight facelift of repository info (lighter fonts, spacing and icons)
166166

167-
### 1.15.0 <small>_ January 2, 2021</small>
167+
### 1.15.0 <small>_ January 2, 2021</small> { id="1.15.0" }
168168

169169
- Added support for native Mermaid.js integration
170170

171-
### 1.14.0 <small>_ December 30, 2020</small>
171+
### 1.14.0 <small>_ December 30, 2020</small> { id="1.14.0" }
172172

173173
- Added support for sharing searches
174174

175-
### 1.13.2 <small>_ December 22, 2020</small>
175+
### 1.13.2 <small>_ December 22, 2020</small> { id="1.13.2" }
176176

177177
- Fixed version selector + sticky tabs navigation rendering issues
178178
- Fixed version selector wrapping
179179

180-
### 1.13.1 <small>_ December 20, 2020</small>
180+
### 1.13.1 <small>_ December 20, 2020</small> { id="1.13.1" }
181181

182182
- Removed horizontal scrollbars on language and version selector
183183
- Fixed type conversion in JavaScript config
184184

185-
### 1.13.0 <small>_ December 13, 2020</small>
185+
### 1.13.0 <small>_ December 13, 2020</small> { id="1.13.0" }
186186

187187
- Refactored navigation tabs to simplify grouping behavior
188188
- Added support for sticky navigation tabs
189189
- Added support for arbitrary links in navigation tabs
190190
- Fixed #2098: Subsequent active subsection not highlighted correctly
191191

192-
### 1.12.1 <small>_ December 8, 2020</small>
192+
### 1.12.1 <small>_ December 8, 2020</small> { id="1.12.1" }
193193

194194
- Fixed empty language selector being shown
195195

196-
### 1.12.0 <small>_ December 6, 2020</small>
196+
### 1.12.0 <small>_ December 6, 2020</small> { id="1.12.0" }
197197

198198
- Added support for adding a language selector
199199

200-
### 1.11.2 <small>_ November 29, 2020</small>
200+
### 1.11.2 <small>_ November 29, 2020</small> { id="1.11.2" }
201201

202202
- Fixed #2068: Search highlight interprets code blocks as JavaScript
203203

204-
### 1.11.1 <small>_ November 29, 2020</small>
204+
### 1.11.1 <small>_ November 29, 2020</small> { id="1.11.1" }
205205

206206
- Refactored styling to be more stable and easier to adjust
207207
- Fixed some styling regressions from latest features
208208

209-
### 1.11.0 <small>_ November 22, 2020</small>
209+
### 1.11.0 <small>_ November 22, 2020</small> { id="1.11.0" }
210210

211211
- Added support for rendering admonitions as inline blocks
212212

213-
### 1.10.0 <small>_ November 15, 2020</small>
213+
### 1.10.0 <small>_ November 15, 2020</small> { id="1.10.0" }
214214

215215
- Added support for integrating table of contents into navigation
216216

217-
### 1.9.0 <small>_ November 7, 2020</small>
217+
### 1.9.0 <small>_ November 7, 2020</small> { id="1.9.0" }
218218

219219
- Added support for hiding navigation and table of contents on any page
220220
- Removed autohiding table of contents when empty
221221

222-
### 1.8.0 <small>_ November 1, 2020</small>
222+
### 1.8.0 <small>_ November 1, 2020</small> { id="1.8.0" }
223223

224224
- Added support for navigation sections
225225
- Fixed appearance of inactive search suggestions
226226

227-
### 1.7.0 <small>_ October 25, 2020</small>
227+
### 1.7.0 <small>_ October 25, 2020</small> { id="1.7.0" }
228228

229229
- Added support for deploying multiple versions
230230
- Fixed alignment of sidebar when content area is too small
231231

232-
### 1.6.0 <small>_ October 11, 2020</small>
232+
### 1.6.0 <small>_ October 11, 2020</small> { id="1.6.0" }
233233

234234
- Added support for search suggestions to save keystrokes
235235
- Added support for removing __Made with Material for MkDocs__ from footer
236236
- Fixed #1915: search should go to first result by pressing ++enter++
237237

238-
### 1.5.1 <small>_ September 21, 2020</small>
238+
### 1.5.1 <small>_ September 21, 2020</small> { id="1.5.1" }
239239

240240
- Fixed content area stretching to whole width for long code blocks
241241

242-
### 1.5.0 <small>_ September 19, 2020</small>
242+
### 1.5.0 <small>_ September 19, 2020</small> { id="1.5.0" }
243243

244244
- Added support for autohiding table of contents when empty
245245

246-
### 1.4.1 <small>_ September 6, 2020</small>
246+
### 1.4.1 <small>_ September 6, 2020</small> { id="1.4.1" }
247247

248248
- Improved typeahead and search result relevance and scoring
249249

250-
### 1.4.0 <small>_ August 30, 2020</small>
250+
### 1.4.0 <small>_ August 30, 2020</small> { id="1.4.0" }
251251

252252
- Added support for autohiding header on scroll
253253

254-
### 1.3.0 <small>_ August 26, 2020</small>
254+
### 1.3.0 <small>_ August 26, 2020</small> { id="1.3.0" }
255255

256256
- Added support for user-selectable color palettes
257257

258-
### 1.2.0 <small>_ August 11, 2020</small>
258+
### 1.2.0 <small>_ August 11, 2020</small> { id="1.2.0" }
259259

260260
- Added feature to expand navigation by default
261261

262-
### 1.1.0 <small>_ August 3, 2020</small>
262+
### 1.1.0 <small>_ August 3, 2020</small> { id="1.1.0" }
263263

264264
- Added highlighting of search results
265265

266-
### 1.0.0 <small>_ July 14, 2020</small>
266+
### 1.0.0 <small>_ July 14, 2020</small> { id="1.0.0" }
267267

268268
- Added grouping of search results
269269
- Added missing query terms to search result

docs/setup/setting-up-site-search.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,9 @@ The following configuration options are supported:
115115

116116
`prebuild_index`{ #search-prebuild-index }
117117

118-
: :octicons-milestone-24: Default: `false` · :octicons-archive-24: Deprecated
119-
· :octicons-trash-24: 8.0.0 – MkDocs can generate a [prebuilt index] of all pages during
118+
: [:octicons-tag-24: 7.2.0][prebuilt index support] · :octicons-archive-24:
119+
Deprecated · :octicons-trash-24: 8.0.0 · :octicons-milestone-24: Default:
120+
`false` – MkDocs can generate a [prebuilt index] of all pages during
120121
build time, which provides performance improvements at the cost of more
121122
bandwidth, as it reduces the build time of the search index:
122123

@@ -145,6 +146,7 @@ them at your own risk.
145146
[lunr's default tokenizer]: https://github.com/olivernn/lunr.js/blob/aa5a878f62a6bba1e8e5b95714899e17e8150b38/lunr.js#L413-L456
146147
[site language]: changing-the-language.md#site-language
147148
[tokenizer lookahead]: #tokenizer-lookahead
149+
[prebuilt index support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
148150
[prebuilt index]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index
149151
[50% smaller]: ../blog/2021/search-better-faster-smaller.md#benchmarks
150152

0 commit comments

Comments
 (0)