Updated Insiders changelog

This commit is contained in:
squidfunk 2022-01-25 20:06:53 +01:00
parent a021c746f5
commit 174c625654
4 changed files with 35 additions and 20 deletions

View File

@ -1,3 +1,7 @@
mkdocs-material-8.1.8+insiders-4.7.0 (2022-01-25)
* Added native support for offline search
mkdocs-material-8.1.8 (2022-01-23)
* Added Latvian translations

View File

@ -6,6 +6,10 @@ template: overrides/main.html
## Material for MkDocs Insiders
### 4.7.0 <small>_ January 25, 2022</small> { id="4.7.0" }
- Added native support for offline search
### 4.6.1 <small>_ January 16, 2022</small> { id="4.6.1" }
- Fixed #3459: Section index pages picking up wrong title

View File

@ -162,8 +162,9 @@ The following features are solely available via Material for MkDocs Insiders:
<div class="mdx-columns" markdown>
- [x] [Offline search] :material-new-box:
- [x] [Annotations] :material-new-box:
- [x] [Navigation icons] :material-new-box:
- [x] [Navigation icons]
- [x] [Code annotations: anchor links]
- [x] [Code annotations: strip comments]
- [x] [Dismissable announcement bar]
@ -243,12 +244,14 @@ are released for general availability.
- [x] [Tokenizer with lookahead]
- [x] [Advanced search highlighting]
- [x] [Excluding content from search]
- [x] [Offline search]
[Brand new search plugin]: ../blog/2021/search-better-faster-smaller.md
[Rich search previews]: ../blog/2021/search-better-faster-smaller.md#rich-search-previews
[Tokenizer with lookahead]: ../blog/2021/search-better-faster-smaller.md#tokenizer-lookahead
[Advanced search highlighting]: ../blog/2021/search-better-faster-smaller.md#accurate-highlighting
[Excluding content from search]: ../setup/setting-up-site-search.md#search-exclusion
[Offline search]: ../setup/setting-up-site-search.md#offline-search
#### $ 12,000 Piri Piri

View File

@ -6,10 +6,10 @@ search:
# Setting up site search
Material for MkDocs provides an excellent, client-side search implementation,
Material for MkDocs provides an excellent client-side search implementation,
omitting the need for the integration of third-party services, which might
be tricky to integrate to be compliant with data privacy regulations. Moreover,
with some effort, search can be made available [offline].
not be compliant with privacy regulations. Moreover, search even works
[offline], allowing users to download your documentation.
[offline]: #offline-search
@ -307,26 +307,30 @@ clipboard.
### Offline search
[:octicons-tag-24: 5.0.0][offline search support] ·
[:octicons-cpu-24: Plugin][localsearch]
[:octicons-heart-fill-24:{ .mdx-heart } Insiders][Insiders]{ .mdx-insiders } ·
[:octicons-tag-24: insiders-4.7.0][Insiders] ·
:octicons-beaker-24: Experimental
If you distribute your documentation as `*.html` files, the built-in search
will not work out-of-the-box due to the restrictions modern browsers impose for
security reasons. This can be mitigated with the [localsearch] plugin in
combination with @squidfunk's [iframe-worker] polyfill.
Insiders makes sure that the built-in search also works when you distribute your
documentation as `*.html` files for download. Simply add the following lines to
`mkdocs.yml`:
For setup instructions, refer to the [localsearch documentation].
``` yaml
use_directory_urls: false
```
This ensures that `index.html` is appended to all internal URLs, which is
necessary for allowing users to view your documentation locally and without
Internet connection. No further setup is necessary your documentation will
work online and offline without any further ado.[^1]
[^1]:
Offline search was previously implemented through the third-party
[localsearch] plugin, which is still possible if you don't want to use
[Insiders]. Note, however, that setup might be challenging if you're not
experienced with MkDocs.
[offline search support]: https://github.com/squidfunk/mkdocs-material/releases/tag/5.0.0
[localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/
[iframe-worker]: https://github.com/squidfunk/iframe-worker
[localsearch documentation]: https://github.com/wilhelmer/mkdocs-localsearch#installation-material-v5
!!! tip
When distributing documentation as HTML files to be opened from the file
system, you will also want to set `use_directory_urls: false` in
`mkdocs.yml` to make page links function correctly.
## Usage