1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-12 01:50:52 +01:00

Documentation

This commit is contained in:
squidfunk 2024-02-19 12:48:18 +07:00
parent 14b55c2f79
commit 2986aca629
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 21 additions and 0 deletions

View File

@ -31,6 +31,16 @@ are rebound automatically, i.e., __Material for MkDocs now behaves like a Single
Page Application__. Now, the search index survives navigation, which is
especially useful for large documentation sites.
!!! info "The [`site_url`][mkdocs.site_url] setting must be set"
Note that you must set [`site_url`][mkdocs.site_url] when using instant
navigation, as instant navigation relies on the generated `sitemap.xml`
which will be empty if this setting is omitted. Example:
``` yaml
site_url: https://example.com
```
[XHR]: https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest
#### Instant prefetching
@ -108,6 +118,16 @@ theme:
- navigation.instant.preview
```
!!! info "The [`site_url`][mkdocs.site_url] setting must be set"
Note that you must set [`site_url`][mkdocs.site_url] when using instant
previews, as instant previews rely on the generated `sitemap.xml`
which will be empty if this setting is omitted. Example:
``` yaml
site_url: https://example.com
```
### Anchor tracking
<!-- md:version 8.0.0 -->

View File

@ -4,6 +4,7 @@
[mkdocs.env]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
[mkdocs.docs_dir]: https://www.mkdocs.org/user-guide/configuration/#docs_dir
[mkdocs.site_dir]: https://www.mkdocs.org/user-guide/configuration/#site_dir
[mkdocs.site_url]: https://www.mkdocs.org/user-guide/configuration/#site_url
[mkdocs.site_description]: https://www.mkdocs.org/user-guide/configuration/#site_description
[mkdocs.nav]: https://www.mkdocs.org/user-guide/configuration/#nav
[mkdocs.plugins]: https://www.mkdocs.org/user-guide/configuration/#plugins