From f664d410d79d1caa0eb949936acb68e480215411 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill <patrick.marsceill@gmail.com> Date: Fri, 1 May 2020 17:31:44 -0400 Subject: [PATCH] Add back to top link and format footer --- _config.yml | 7 +++++++ _layouts/default.html | 39 ++++++++++++++++++++++++--------------- _sass/base.scss | 1 + 3 files changed, 32 insertions(+), 15 deletions(-) diff --git a/_config.yml b/_config.yml index ddaf13d0..42ccec24 100644 --- a/_config.yml +++ b/_config.yml @@ -47,12 +47,19 @@ nav_sort: case_insensitive # default, equivalent to nil # Footer content # appears at the bottom of every page's main content + +# Back to top link +back_to_top: true +back_to_top_text: "Back to top" + footer_content: "Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>" # Footer last edited timestamp last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html + + # Footer "Edit this page on GitHub" link text gh_edit_link: true # show or hide edit this page link gh_edit_link_text: "Edit this page on GitHub" diff --git a/_layouts/default.html b/_layouts/default.html index 4ab86930..de394ddb 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -29,7 +29,7 @@ layout: table_wrappers </footer> </div> <div class="main-content-wrap js-main-content" tabindex="0"> - <div class="main-content"> + <div class="main-content" id="top"> <div class="page-header js-page-header"> {% if site.search_enabled != false %} <div class="search"> @@ -96,28 +96,37 @@ layout: table_wrappers {% if site.footer_content != nil or site.last_edit_timestamp or site.gh_edit_link %} <hr> - <footer role="contentinfo"> - {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %} - <p class="text-small text-grey-dk-000 mb-0"> - Page last modified: {{ page.last_modified_date | date: site.last_edit_time_format }}. - </p> + <footer> + {% if site.back_to_top %} + <p><a href="#top">{{ site.back_to_top_text }}</a></p> {% endif %} - {% - if + {% if site.footer_content != nil %} + <p class="text-small text-grey-dk-000 mb-0">{{ site.footer_content }}</p> + {% endif %} + + {% if site.last_edit_timestamp or site.gh_edit_link %} + <div class="d-flex mt-2"> + {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %} + <p class="text-small text-grey-dk-000 mb-0 mr-2"> + Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>. + </p> + {% endif %} + {% + if site.gh_edit_link and site.gh_edit_link_text and site.gh_edit_repository and site.gh_edit_branch and site.gh_edit_view_mode - %} - <p class="text-small text-grey-dk-000 mb-0"> - <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}">{{ site.gh_edit_link_text }}</a> - </p> - {% endif %} - {% if site.footer_content != nil %} - <p class="text-small text-grey-dk-000 mb-0">{{ site.footer_content }}</p> + %} + <p class="text-small text-grey-dk-000 mb-0"> + <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}">{{ site.gh_edit_link_text }}</a> + </p> + {% endif %} + </div> {% endif %} + </footer> {% endif %} diff --git a/_sass/base.scss b/_sass/base.scss index 99402c8c..20e49e8c 100644 --- a/_sass/base.scss +++ b/_sass/base.scss @@ -14,6 +14,7 @@ html { @include fs-4; + scroll-behavior: smooth; } body { -- GitLab