From ddd125ee744fe25fb0a78c809406d9fa9fb57ae2 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Mon, 2 Oct 2023 11:37:20 +0200 Subject: [PATCH] Documentation --- docs/setup/setting-up-navigation.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index 74ab68c3c..a6b64f350 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -52,6 +52,28 @@ theme: - navigation.instant.prefetch ``` +#### Progress indicator + + + + + +In order to provide a better user experience on slow connections when using +instant navigation, a progress indicator can be enabled. It will be shown at +the top of the page and will be hidden once the page has fully loaded. You can +enable it in `mkdocs.yml` with: + +``` yaml +theme: + features: + - navigation.instant + - navigation.instant.progress +``` + +The progress indicator will only show if the page hasn't finished loading after +400ms, so that fast connections will never show it for a better instant +experience. + ### Anchor tracking