Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs navigation fails on Safari #528

Closed
planetf1 opened this issue Sep 28, 2022 · 0 comments · Fixed by #529
Closed

Docs navigation fails on Safari #528

planetf1 opened this issue Sep 28, 2022 · 0 comments · Fixed by #529

Comments

@planetf1
Copy link
Member

When using Safari, anchor links do not work properly.

For example, go to https://egeria-project.org/concepts/discovery-analysis-report, scroll down and click on 'Data Class Annotation'.
This links to https://egeria-project.org/features/discovery-and-stewardship/overview/#data-class-discovery

If this link is clicked in safari, although the link goes to the right page, it does not correctly scroll to the correct location - or indeed scroll down at all.

This seems to affect all versions, including Ventura & Safari Technology Preview

In Chrome & Safari the links work correctly.

On digging, it appears this is caused by one of thge navigation features (navigation.instant). This is discussed in squidfunk/mkdocs-material#2881 and in the mkdocs docs at https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading

Although this feature in theory speeds up navigation, I think the ability to work across browser is more important. It's not clear whether this is a safari bug, or a mkdocs bug (safari often keeps closer to standards, and can be less pragmatic)

This bug was introduced by:

94327250f (Nigel Jones         2022-01-11 19:56:27 +0000 834)     - navigation.instant

I therefore propose to revert.

planetf1 added a commit to planetf1/egeria-docs that referenced this issue Sep 28, 2022
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit that referenced this issue Sep 29, 2022
#528 unset navigation.instant to allow anchors to work in Safari
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant