Skip to content

Commit 174c625

Browse files
committed
Updated Insiders changelog
1 parent a021c74 commit 174c625

File tree

4 files changed

+34
-19
lines changed

4 files changed

+34
-19
lines changed

CHANGELOG

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
mkdocs-material-8.1.8+insiders-4.7.0 (2022-01-25)
2+
3+
* Added native support for offline search
4+
15
mkdocs-material-8.1.8 (2022-01-23)
26

37
* Added Latvian translations

docs/insiders/changelog.md

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

77
## Material for MkDocs Insiders
88

9+
### 4.7.0 <small>_ January 25, 2022</small> { id="4.7.0" }
10+
11+
- Added native support for offline search
12+
913
### 4.6.1 <small>_ January 16, 2022</small> { id="4.6.1" }
1014

1115
- Fixed #3459: Section index pages picking up wrong title

docs/insiders/index.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,9 @@ The following features are solely available via Material for MkDocs Insiders:
162162

163163
<div class="mdx-columns" markdown>
164164

165+
- [x] [Offline search] :material-new-box:
165166
- [x] [Annotations] :material-new-box:
166-
- [x] [Navigation icons] :material-new-box:
167+
- [x] [Navigation icons]
167168
- [x] [Code annotations: anchor links]
168169
- [x] [Code annotations: strip comments]
169170
- [x] [Dismissable announcement bar]
@@ -243,12 +244,14 @@ are released for general availability.
243244
- [x] [Tokenizer with lookahead]
244245
- [x] [Advanced search highlighting]
245246
- [x] [Excluding content from search]
247+
- [x] [Offline search]
246248

247249
[Brand new search plugin]: ../blog/2021/search-better-faster-smaller.md
248250
[Rich search previews]: ../blog/2021/search-better-faster-smaller.md#rich-search-previews
249251
[Tokenizer with lookahead]: ../blog/2021/search-better-faster-smaller.md#tokenizer-lookahead
250252
[Advanced search highlighting]: ../blog/2021/search-better-faster-smaller.md#accurate-highlighting
251253
[Excluding content from search]: ../setup/setting-up-site-search.md#search-exclusion
254+
[Offline search]: ../setup/setting-up-site-search.md#offline-search
252255

253256
#### $ 12,000 – Piri Piri
254257

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

+22-18
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ search:
66

77
# Setting up site search
88

9-
Material for MkDocs provides an excellent, client-side search implementation,
9+
Material for MkDocs provides an excellent client-side search implementation,
1010
omitting the need for the integration of third-party services, which might
11-
be tricky to integrate to be compliant with data privacy regulations. Moreover,
12-
with some effort, search can be made available [offline].
11+
not be compliant with privacy regulations. Moreover, search even works
12+
[offline], allowing users to download your documentation.
1313

1414
[offline]: #offline-search
1515

@@ -307,26 +307,30 @@ clipboard.
307307

308308
### Offline search
309309

310-
[:octicons-tag-24: 5.0.0][offline search support] ·
311-
[:octicons-cpu-24: Plugin][localsearch]
310+
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
311+
[:octicons-tag-24: insiders-4.7.0][Insiders] ·
312+
:octicons-beaker-24: Experimental
312313

313-
If you distribute your documentation as `*.html` files, the built-in search
314-
will not work out-of-the-box due to the restrictions modern browsers impose for
315-
security reasons. This can be mitigated with the [localsearch] plugin in
316-
combination with @squidfunk's [iframe-worker] polyfill.
314+
Insiders makes sure that the built-in search also works when you distribute your
315+
documentation as `*.html` files for download. Simply add the following lines to
316+
`mkdocs.yml`:
317317

318-
For setup instructions, refer to the [localsearch documentation].
318+
``` yaml
319+
use_directory_urls: false
320+
```
319321

320-
[offline search support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
321-
[localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/
322-
[iframe-worker]: https://github.com/squidfunk/iframe-worker
323-
[localsearch documentation]: https://github.com/wilhelmer/mkdocs-localsearch#installation-material-v5
322+
This ensures that `index.html` is appended to all internal URLs, which is
323+
necessary for allowing users to view your documentation locally and without
324+
Internet connection. No further setup is necessary – your documentation will
325+
work online and offline without any further ado.[^1]
324326

325-
!!! tip
327+
[^1]:
328+
Offline search was previously implemented through the third-party
329+
[localsearch] plugin, which is still possible if you don't want to use
330+
[Insiders]. Note, however, that setup might be challenging if you're not
331+
experienced with MkDocs.
326332

327-
When distributing documentation as HTML files to be opened from the file
328-
system, you will also want to set `use_directory_urls: false` in
329-
`mkdocs.yml` to make page links function correctly.
333+
[localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/
330334

331335
## Usage
332336

0 commit comments

Comments
 (0)