-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Back-to-top link not shown #1443
Comments
Thanks for submitting this issue! I agree with both the expected behavior and additional context points. Without having implemented it yet, I think the following should be simple-ish to do:
Does that seem like it properly captures the issue? If so, we can mark this as ready to implement, and I can add it to my backlog (time to complete is up-in-the-air) and/or have someone else take it on (e.g. you!). From a bigger picture perspective, it would be great to eventually nest all of these keys under some sort of footer:
content: "Lorem ipsum..." # this would replace site.footer_content
back_to_top: true # this would replace site.back_to_top
# ditto for last_edit, gh_edit, ... This would be a breaking change, so we'd probably have to defer to a v1. Broadly speaking, do you think this is a good idea? |
Describe the bug
The theme has a (currently undocumented) site configuration option
back_to_top
. The theme docs set this option, and at the bottom of each docs page there is a link to the top of the page. However, this link is shown only when some unrelated options are set.To Reproduce
Steps to reproduce the behavior:
_config.yml
remove or comment out the settings forfooter_content
,last_edit_*
, andgh_edit_*
.Expected behavior
Whether the "Back to top" link is shown should be independent of the configuration settings for unrelated features.
Screenshots
N/A.
Desktop:
Smartphone:
N/A
Additional context
The obvious fix is to always render the footer when
site.back_to_top
is set. However, it would improve the usability of the back-to-top feature if individual pages could override the site setting (to suppress the link on some short pages, or to show it on some long pages).In any case, the back-to-top feature should be explained in the theme docs.
The text was updated successfully, but these errors were encountered: