From 97efc81fa904054e367d9fb1f5df7f11e2a90e6b Mon Sep 17 00:00:00 2001 From: Matthew Wang <matt@matthewwang.me> Date: Wed, 11 Sep 2019 15:31:47 -0700 Subject: [PATCH] implements configuration for footer data and "edit this page" functionality --- _config.yml | 6 ++++++ _layouts/default.html | 14 +++++++++----- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/_config.yml b/_config.yml index d12d4396..cab96f57 100644 --- a/_config.yml +++ b/_config.yml @@ -34,6 +34,12 @@ aux_links: # Footer content appears at the bottom of every page's main content footer_content: "Copyright © 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>" +# Footer metadata +show_last_edit_time: true +last_edit_time_format: "%b %e %Y at %I:%M %p" +show_gh_edit_link: true +gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" +edit_link_text: "Edit this page on GitHub" # Color scheme currently only supports "dark" or nil (default) color_scheme: nil diff --git a/_layouts/default.html b/_layouts/default.html index d56132ef..e7d49963 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -59,9 +59,6 @@ layout: table_wrappers {% endif %} {% endunless %} <div id="main-content" class="page-content" role="main"> - {% if page.last_modified_date %} - <p class="text-small text-grey-dk-000 mb-0">Page last modified: {{ page.last_modified_date | date: "%Y-%m-%d %H:%M" }}</p> - {% endif %} {% if site.heading_anchors != false %} {% include vendor/anchor_headings.html html=content beforeHeading = "true" anchorBody="<svg class=\"d-inline-block v-align-middle\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"18\" height=\"18\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg>" anchorClass="anchor-heading" %} {% else %} @@ -86,8 +83,15 @@ layout: table_wrappers {% if site.footer_content != nil %} <hr> <footer role="contentinfo"> - {% if page.last_modified_date %} - <p class="text-small text-grey-dk-000 mb-0">Page last modified: {{ page.last_modified_date | date: "%Y-%m-%d %H:%M" }}</p> + {% if site.show_last_edit_time 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> + {% endif %} + {% if site.show_gh_edit_link and site.edit_link_text %} + <p class="text-small text-grey-dk-000 mb-0"> + <a href="{{ site.gh_edit_repository }}/tree/master/{{ page.path }}">Edit this page on GitHub.</a> + </p> {% endif %} <p class="text-small text-grey-dk-000 mb-0">{{ site.footer_content }}</p> </footer> -- GitLab