starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-08-02 10:48:49 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk
2024-02-19 12:48:18 +07:00
parent 14b55c2f79
commit 2986aca629
2 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/setup/setting-up-navigation.md
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 -->