Merge pull request #4585 from squidfunk/docs/simplify-overrides

Simplify local overrides

.github/workflows/publish.yml

@@ -91,7 +91,9 @@ jobs:
             ghcr.io/${{ github.event.repository.full_name }}:${{ github.event.release.tag_name }}
 
       - name: Check Docker image
-        run:
+        working-directory: /tmp
+        run: |
+          docker run --rm -i -v ${PWD}:/docs ${{ github.event.repository.full_name }} new .
           docker run --rm -i -v ${PWD}:/docs ${{ github.event.repository.full_name }} build
 
       - name: Publish Docker image

docs/alternatives.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Alternatives
 
 There are tons of static site generators and themes out there and choosing the

docs/browser-support.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Browser support
 
 Material for MkDocs goes at great lengths to support the largest possible range

docs/changelog/index.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changelog
 
 ## Material for MkDocs

docs/creating-your-site.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Creating your site
 
 After you've [installed] Material for MkDocs, you can bootstrap your project 

docs/customization.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Customization
 
 Project documentation is as diverse as the projects themselves and Material for

docs/getting-started.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Getting started
 
 Material for MkDocs is a theme for [MkDocs], a static site generator geared

docs/index.md

@@ -1,4 +1,6 @@
 ---
-template: overrides/home.html
+template: home.html
 title: Material for MkDocs
 ---
+
+Welcome to Material for MkDocs.

docs/insiders/changelog.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changelog
 
 ## Material for MkDocs Insiders

docs/insiders/getting-started.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 title: Getting started with Insiders
 ---
 

docs/insiders/index.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 title: Insiders
 ---
 

docs/license.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # License
 
 **MIT License**

docs/philosophy.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Philosophy
 
 Before settling for Material for MkDocs, it's a good idea to understand the

docs/publishing-your-site.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Publishing your site
 
 The great thing about hosting project documentation in a `git` repository is

docs/reference/admonitions.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/alert-outline
 ---
 

docs/reference/annotations.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/plus-circle
 ---
 

docs/reference/buttons.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/gesture-tap-button
 ---
 

docs/reference/code-blocks.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/code-json
 ---
 

docs/reference/content-tabs.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/tab
 ---
 

docs/reference/data-tables.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/table-edit
 ---
 

docs/reference/diagrams.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/graph-outline
 ---
 

docs/reference/footnotes.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/format-align-bottom
 ---
 

docs/reference/formatting.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/format-font
 ---
 

docs/reference/grids.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/view-grid-plus
 ---
 

docs/reference/icons-emojis.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/emoticon-happy-outline
 ---
 

docs/reference/images.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/image-frame
 ---
 

docs/reference/index.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Reference
 
 Material for MkDocs is packed with many great features that make technical

docs/reference/lists.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/format-list-bulleted
 ---
 

docs/reference/mathjax.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/alphabet-greek
 ---
 

docs/reference/tooltips.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/tooltip-plus
 status: new
 ---

docs/setup/adding-a-comment-system.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Adding a comment system
 
 Material for MkDocs allows to easily add the third-party comment system of your

docs/setup/adding-a-git-repository.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Adding a git repository
 
 If your documentation is related to source code, Material for MkDocs provides

docs/setup/building-for-offline-usage.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Building for offline usage
 
 If you want to ship your documentation together with your product, MkDocs has

docs/setup/changing-the-colors.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changing the colors
 
 As any proper Material Design implementation, Material for MkDocs supports

docs/setup/changing-the-fonts.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changing the fonts
 
 Material for MkDocs makes it easy to change the typeface of your project

docs/setup/changing-the-language.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changing the language
 
 Material for MkDocs supports internationalization (i18n) and provides

docs/setup/changing-the-logo-and-icons.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changing the logo and icons
 
 When installing Material for MkDocs, you immediately get access to _over 8,000 

docs/setup/ensuring-data-privacy.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Ensuring data privacy
 
 Material for MkDocs makes compliance with data privacy regulations very easy, 

docs/setup/extensions/index.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 title: Extensions
 ---
 

docs/setup/extensions/python-markdown-extensions.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Python Markdown Extensions
 
 The [Python Markdown Extensions] package is an excellent collection of

docs/setup/extensions/python-markdown.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Python Markdown
 
 Material for MkDocs supports a large number of [Python Markdown] extensions,

docs/setup/setting-up-a-blog.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 status: new
 ---
 

docs/setup/setting-up-navigation.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up navigation
 
 A clear and concise navigation structure is an important aspect of good project 

docs/setup/setting-up-site-analytics.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up site analytics
 
 As with any other service offered on the web, understanding how your project

docs/setup/setting-up-site-search.md

@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 search:
   boost: 1.05
 ---

docs/setup/setting-up-social-cards.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up social cards
 
 Social cards, also known as social previews, are images that are displayed when

docs/setup/setting-up-tags.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up tags
 
 Material for MkDocs adds first-class support for categorizing pages with tags,

docs/setup/setting-up-the-footer.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up the footer
 
 The footer of your project documentation is a great place to add links to

docs/setup/setting-up-the-header.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up the header
 
 Material for MkDocs' header can be customized to show an announcement bar that 

docs/setup/setting-up-versioning.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Setting up versioning
 
 Material for MkDocs makes it easy to deploy multiple versions of your project

docs/upgrade.md

@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # How to upgrade
 
 Upgrade to the latest version with:

material/overrides/blog.html

@@ -1,10 +0,0 @@
-{#-
-  This file was automatically generated - do not edit
--#}
-{% extends "overrides/main.html" %}
-{% block content %}
-  {{ super() }}
-  <h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
-  <script src="https://giscus.app/client.js" data-repo="squidfunk/mkdocs-material" data-repo-id="MDEwOlJlcG9zaXRvcnk1MDYxNzQyOA==" data-category="_" data-category-id="DIC_kwDOAwRcVM4CAtJY" data-mapping="pathname" data-reactions-enabled="1" data-emit-metadata="1" data-theme="light" data-lang="en" crossorigin="anonymous" async></script>
-  <script>var theme,giscus=document.querySelector("script[src*=giscus]"),palette=__md_get("__palette");palette&&"object"==typeof palette.color&&(theme="slate"===palette.color.scheme?"dark":"light",giscus.setAttribute("data-theme",theme)),document.addEventListener("DOMContentLoaded",function(){document.querySelector("[data-md-component=palette]").addEventListener("change",function(){var e=__md_get("__palette");e&&"object"==typeof e.color&&(e="slate"===e.color.scheme?"dark":"light",document.querySelector(".giscus-frame").contentWindow.postMessage({giscus:{setConfig:{theme:e}}},"https://giscus.app"))})})</script>
-{% endblock %}

material/overrides/main.html

@@ -14,9 +14,6 @@
     <strong>Twitter</strong>
   </a>
 {% endblock %}
-{% block content %}
-  {% include "overrides/partials/content.html" %}
-{% endblock %}
 {% block scripts %}
   {{ super() }}
   <script src="{{ 'overrides/assets/javascripts/bundle.d665d539.min.js' | url }}"></script>

material/overrides/partials/content.html

@@ -1,18 +0,0 @@
-{#-
-  This file was automatically generated - do not edit
--#}
-{% if "tags" in config.plugins %}
-  {% include "partials/tags.html" %}
-{% endif %}
-{% include "overrides/partials/actions.html" %}
-{% if not "\x3ch1" in page.content %}
-  <h1>{{ page.title | d(config.site_name, true)}}</h1>
-{% endif %}
-{{ page.content }}
-{% if page.meta and (
-  page.meta.git_revision_date_localized or
-  page.meta.revision_date
-) %}
-  {% include "partials/source-file.html" %}
-{% endif %}
-{% include "partials/feedback.html" %}

mkdocs.yml

@@ -36,6 +36,7 @@ copyright: Copyright © 2016 - 2022 Martin Donath
 # Configuration
 theme:
   name: material
+  custom_dir: material/overrides
   features:
     # - announce.dismiss
     - content.code.annotate

src/overrides/blog.html

@@ -1,76 +0,0 @@
-<!--
-  Copyright (c) 2016-2022 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.
--->
-
-{% extends "overrides/main.html" %}
-
-<!-- Content -->
-{% block content %}
-  {{ super() }}
-
-  <!-- Giscus - generated by https://giscus.app -->
-  <h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
-  <script
-    src="https://giscus.app/client.js"
-    data-repo="squidfunk/mkdocs-material"
-    data-repo-id="MDEwOlJlcG9zaXRvcnk1MDYxNzQyOA=="
-    data-category="_"
-    data-category-id="DIC_kwDOAwRcVM4CAtJY"
-    data-mapping="pathname"
-    data-reactions-enabled="1"
-    data-emit-metadata="1"
-    data-theme="light"
-    data-lang="en"
-    crossorigin="anonymous"
-    async
-  >
-  </script>
-
-  <!-- Synchronize Giscus theme with palette -->
-  <script>
-    var giscus = document.querySelector("script[src*=giscus]")
-
-    /* Set palette on initial load */
-    var palette = __md_get("__palette")
-    if (palette && typeof palette.color === "object") {
-      var theme = palette.color.scheme === "slate" ? "dark" : "light"
-      giscus.setAttribute("data-theme", theme)
-    }
-
-    /* Register event handlers after documented loaded */
-    document.addEventListener("DOMContentLoaded", function() {
-      var ref = document.querySelector("[data-md-component=palette]")
-      ref.addEventListener("change", function() {
-        var palette = __md_get("__palette")
-        if (palette && typeof palette.color === "object") {
-          var theme = palette.color.scheme === "slate" ? "dark" : "light"
-
-          /* Instruct Giscus to change theme */
-          var frame = document.querySelector(".giscus-frame")
-          frame.contentWindow.postMessage(
-            { giscus: { setConfig: { theme } } },
-            "https://giscus.app"
-          )
-        }
-      })
-    })
-  </script>
-{% endblock %}

src/overrides/main.html

@@ -43,11 +43,6 @@
   </a>
 {% endblock %}
 
-<!-- Content -->
-{% block content %}
-  {% include "overrides/partials/content.html" %}
-{% endblock %}
-
 <!-- Theme-related JavaScript -->
 {% block scripts %}
   {{ super() }}

src/overrides/partials/content.html

@@ -1,51 +0,0 @@
-<!--
-  Copyright (c) 2016-2022 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.
--->
-
-<!-- Tags -->
-{% if "tags" in config.plugins %}
-  {% include "partials/tags.html" %}
-{% endif %}
-
-<!-- Actions -->
-{% include "overrides/partials/actions.html" %}
-
-<!--
-  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 %}
-
-<!-- Page content -->
-{{ page.content }}
-
-<!-- Source file information -->
-{% if page.meta and (
-  page.meta.git_revision_date_localized or
-  page.meta.revision_date
-) %}
-  {% include "partials/source-file.html" %}
-{% endif %}
-
-<!-- Was this page helpful? -->
-{% include "partials/feedback.html" %}