Improved extensibility by restructuring template blocks

material/base.html

@@ -160,24 +160,9 @@
           <div class="md-content" data-md-component="content">
             <article class="md-content__inner md-typeset">
               {% block content %}
-                {% if page.edit_url %}
+                {% include "partials/page-header.html" %}
-                  <a href="{{ page.edit_url }}" title="{{ lang.t('edit.link.title') }}" class="md-content__button md-icon">
+                {% include "partials/page.html" %}
-                    {% include ".icons/material/pencil.svg" %}
+                {% include "partials/page-footer.html" %}
-                  </a>
-                {% endif %}
-                {% if not "\x3ch1" in page.content %}
-                  <h1>{{ page.title | d(config.site_name, true)}}</h1>
-                {% endif %}
-                {{ page.content }}
-                {% if page and page.meta and (
-                  page.meta.git_revision_date_localized or
-                  page.meta.revision_date
-                ) %}
-                  {% include "partials/source-file.html" %}
-                {% endif %}
-              {% endblock %}
-              {% block disqus %}
-                {% include "partials/integrations/disqus.html" %}
               {% endblock %}
             </article>
           </div>

material/partials/footer.html

@@ -55,7 +55,9 @@
         {% endif %}
         {{ extracopyright }}
       </div>
-      {% include "partials/social.html" %}
+      {% if config.extra.social %}
+        {% include "partials/social.html" %}
+      {% endif %}
     </div>
   </div>
 </footer>

material/partials/page-footer.html

@@ -0,0 +1,12 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+{% if page and page.meta and (
+  page.meta.git_revision_date_localized or
+  page.meta.revision_date
+) %}
+  {% include "partials/source-file.html" %}
+{% endif %}
+{% block disqus %}
+  {% include "partials/integrations/disqus.html" %}
+{% endblock %}

material/partials/page-header.html

@@ -0,0 +1,8 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+{% if page.edit_url %}
+<a href="{{ page.edit_url }}" title="{{ lang.t('edit.link.title') }}" class="md-content__button md-icon">
+  {% include ".icons/material/pencil.svg" %}
+</a>
+{% endif %}

material/partials/page.html

@@ -0,0 +1,7 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+{% if not "\x3ch1" in page.content %}
+  <h1>{{ page.title | d(config.site_name, true)}}</h1>
+{% endif %}
+{{ page.content }}

material/partials/social.html

@@ -1,17 +1,15 @@
 {#-
   This file was automatically generated - do not edit
 -#}
-{% if config.extra.social %}
+<div class="md-footer-social">
-  <div class="md-footer-social">
+  {% for social in config.extra.social %}
-    {% for social in config.extra.social %}
+    {% set title = social.name %}
-      {% set title = social.name %}
+    {% if not title and "//" in social.link %}
-      {% if not title and "//" in social.link %}
+      {% set _, url = social.link.split("//") %}
-        {% set _,url = social.link.split("//") %}
+      {% set title  = url.split("/")[0] %}
-        {% set title = url.split("/")[0] %}
+    {% endif %}
-      {% endif %}
+    <a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ title | e }}" class="md-footer-social__link">
-      <a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ title | e }}" class="md-footer-social__link">
+      {% include ".icons/" ~ social.icon ~ ".svg" %}
-        {% include ".icons/" ~ social.icon ~ ".svg" %}
+    </a>
-      </a>
+  {% endfor %}
-    {% endfor %}
+</div>
-  </div>
-{% endif %}

material/partials/source-file.html

@@ -3,7 +3,7 @@
 -#}
 {% import "partials/language.html" as lang with context %}
 <hr>
-<div class="md-source-date">
+<div class="md-source-file">
   <small>
     {% if page.meta.git_revision_date_localized %}
       {{ lang.t("source.file.date.updated") }}:

src/base.html

@@ -288,48 +288,13 @@
             {% endif %}
           {% endblock %}
 
-          <!-- Article -->
+          <!-- Page content -->
           <div class="md-content" data-md-component="content">
             <article class="md-content__inner md-typeset">
-
-              <!-- Content -->
               {% block content %}
-
+                {% include "partials/page-header.html" %}
-                <!-- Edit button -->
+                {% include "partials/page.html" %}
-                {% if page.edit_url %}
+                {% include "partials/page-footer.html" %}
-                  <a
-                    href="{{ page.edit_url }}"
-                    title="{{ lang.t('edit.link.title') }}"
-                    class="md-content__button md-icon"
-                  >
-                    {% include ".icons/material/pencil.svg" %}
-                  </a>
-                {% endif %}
-
-                <!--
-                  Hack: check whether the content contains a h1 headline. If it
-                  doesn't, the page title (or respectively site name) is used
-                  as the main headline.
-                -->
-                {% if not "\x3ch1" in page.content %}
-                  <h1>{{ page.title | d(config.site_name, true)}}</h1>
-                {% endif %}
-
-                <!-- Markdown content -->
-                {{ page.content }}
-
-                <!-- Last update of source file -->
-                {% if page and page.meta and (
-                  page.meta.git_revision_date_localized or
-                  page.meta.revision_date
-                ) %}
-                  {% include "partials/source-file.html" %}
-                {% endif %}
-              {% endblock %}
-
-              <!-- Disqus integration -->
-              {% block disqus %}
-                {% include "partials/integrations/disqus.html" %}
               {% endblock %}
             </article>
           </div>

src/partials/footer.html

@@ -104,7 +104,9 @@
       </div>
 
       <!-- Social links -->
-      {% include "partials/social.html" %}
+      {% if config.extra.social %}
+        {% include "partials/social.html" %}
+      {% endif %}
     </div>
   </div>
 </footer>

src/partials/page-footer.html

@@ -0,0 +1,34 @@
+<!--
+  Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+<!-- Source file information -->
+{% if page and page.meta and (
+  page.meta.git_revision_date_localized or
+  page.meta.revision_date
+) %}
+  {% include "partials/source-file.html" %}
+{% endif %}
+
+<!-- Disqus integration -->
+{% block disqus %}
+  {% include "partials/integrations/disqus.html" %}
+{% endblock %}

src/partials/page-header.html

@@ -0,0 +1,32 @@
+<!--
+  Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+<!-- Edit button -->
+{% if page.edit_url %}
+<a
+  href="{{ page.edit_url }}"
+  title="{{ lang.t('edit.link.title') }}"
+  class="md-content__button md-icon"
+>
+  {% include ".icons/material/pencil.svg" %}
+</a>
+{% endif %}

src/partials/page.html

@@ -0,0 +1,33 @@
+<!--
+  Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal in the Software without restriction, including without limitation the
+  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+  sell copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+  IN THE SOFTWARE.
+-->
+
+<!--
+  Hack: check whether the content contains a h1 headline. If it
+  doesn't, the page title (or respectively site name) is used
+  as the main headline.
+-->
+{% if not "\x3ch1" in page.content %}
+  <h1>{{ page.title | d(config.site_name, true)}}</h1>
+{% endif %}
+
+<!-- Markdown content -->
+{{ page.content }}

src/partials/social.html

@@ -21,22 +21,20 @@
 -->
 
 <!-- Social links in footer -->
-{% if config.extra.social %}
+<div class="md-footer-social">
-  <div class="md-footer-social">
+  {% for social in config.extra.social %}
-    {% for social in config.extra.social %}
+    {% set title = social.name %}
-      {% set title = social.name %}
+    {% if not title and "//" in social.link %}
-      {% if not title and "//" in social.link %}
+      {% set _, url = social.link.split("//") %}
-        {% set _,url = social.link.split("//") %}
+      {% set title  = url.split("/")[0] %}
-        {% set title = url.split("/")[0] %}
+    {% endif %}
-      {% endif %}
+    <a
-      <a
+      href="{{ social.link }}"
-        href="{{ social.link }}"
+      target="_blank" rel="noopener"
-        target="_blank" rel="noopener"
+      title="{{ title | e }}"
-        title="{{ title | e }}"
+      class="md-footer-social__link"
-        class="md-footer-social__link"
+    >
-      >
+      {% include ".icons/" ~ social.icon ~ ".svg" %}
-        {% include ".icons/" ~ social.icon ~ ".svg" %}
+    </a>
-      </a>
+  {% endfor %}
-    {% endfor %}
+</div>
-  </div>
-{% endif %}

src/partials/source-file.html

@@ -22,9 +22,9 @@
 
 {% import "partials/language.html" as lang with context %}
 
-<!-- Last updated date -->
+<!-- Source file information -->
 <hr />
-<div class="md-source-date">
+<div class="md-source-file">
   <small>
 
     <!-- mkdocs-git-revision-date-localized-plugin -->