Skip to content

Commit ddd125e

Browse files
committed
Documentation
1 parent bf06bbf commit ddd125e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/setup/setting-up-navigation.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,28 @@ theme:
5252
- navigation.instant.prefetch
5353
```
5454
55+
#### Progress indicator
56+
57+
<!-- md:version 9.4.3 -->
58+
<!-- md:feature -->
59+
<!-- md:flag experimental -->
60+
61+
In order to provide a better user experience on slow connections when using
62+
instant navigation, a progress indicator can be enabled. It will be shown at
63+
the top of the page and will be hidden once the page has fully loaded. You can
64+
enable it in `mkdocs.yml` with:
65+
66+
``` yaml
67+
theme:
68+
features:
69+
- navigation.instant
70+
- navigation.instant.progress
71+
```
72+
73+
The progress indicator will only show if the page hasn't finished loading after
74+
400ms, so that fast connections will never show it for a better instant
75+
experience.
76+
5577
### Anchor tracking
5678

5779
<!-- md:version 8.0.0 -->

0 commit comments

Comments
 (0)