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

squidfunk · web-flow · commit 9e8446e357b8 · 2022-11-03T15:31:57.000+01:00
Simplify local overrides
diff --git a/.github/workflows/publish.yml b/.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
diff --git a/docs/alternatives.md b/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
diff --git a/docs/browser-support.md b/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
diff --git a/docs/changelog/index.md b/docs/changelog/index.md
@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changelog
 
 ## Material for MkDocs
diff --git a/docs/creating-your-site.md b/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 
diff --git a/docs/customization.md b/docs/customization.md
@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Customization
 
 Project documentation is as diverse as the projects themselves and Material for
diff --git a/docs/getting-started.md b/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
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,6 @@
 ---
-template: overrides/home.html
+template: home.html
 title: Material for MkDocs
 ---
+
+Welcome to Material for MkDocs.
diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md
@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # Changelog
 
 ## Material for MkDocs Insiders
diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 title: Getting started with Insiders
 ---
 
diff --git a/docs/insiders/index.md b/docs/insiders/index.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 title: Insiders
 ---
 
diff --git a/docs/license.md b/docs/license.md
@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # License
 
 **MIT License**
diff --git a/docs/philosophy.md b/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
diff --git a/docs/publishing-your-site.md b/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
diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/alert-outline
 ---
 
diff --git a/docs/reference/annotations.md b/docs/reference/annotations.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/plus-circle
 ---
 
diff --git a/docs/reference/buttons.md b/docs/reference/buttons.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/gesture-tap-button
 ---
 
diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/code-json
 ---
 
diff --git a/docs/reference/content-tabs.md b/docs/reference/content-tabs.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/tab
 ---
 
diff --git a/docs/reference/data-tables.md b/docs/reference/data-tables.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/table-edit
 ---
 
diff --git a/docs/reference/diagrams.md b/docs/reference/diagrams.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/graph-outline
 ---
 
diff --git a/docs/reference/footnotes.md b/docs/reference/footnotes.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/format-align-bottom
 ---
 
diff --git a/docs/reference/formatting.md b/docs/reference/formatting.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/format-font
 ---
 
diff --git a/docs/reference/grids.md b/docs/reference/grids.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/view-grid-plus
 ---
 
diff --git a/docs/reference/icons-emojis.md b/docs/reference/icons-emojis.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/emoticon-happy-outline
 ---
 
diff --git a/docs/reference/images.md b/docs/reference/images.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/image-frame
 ---
 
diff --git a/docs/reference/index.md b/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
diff --git a/docs/reference/lists.md b/docs/reference/lists.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/format-list-bulleted
 ---
 
diff --git a/docs/reference/mathjax.md b/docs/reference/mathjax.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/alphabet-greek
 ---
 
diff --git a/docs/reference/tooltips.md b/docs/reference/tooltips.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 icon: material/tooltip-plus
 status: new
 ---
diff --git a/docs/setup/adding-a-comment-system.md b/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
diff --git a/docs/setup/adding-a-git-repository.md b/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
diff --git a/docs/setup/building-for-offline-usage.md b/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
diff --git a/docs/setup/changing-the-colors.md b/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
diff --git a/docs/setup/changing-the-fonts.md b/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
diff --git a/docs/setup/changing-the-language.md b/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
diff --git a/docs/setup/changing-the-logo-and-icons.md b/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 
diff --git a/docs/setup/ensuring-data-privacy.md b/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, 
diff --git a/docs/setup/extensions/index.md b/docs/setup/extensions/index.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 title: Extensions
 ---
 
diff --git a/docs/setup/extensions/python-markdown-extensions.md b/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
diff --git a/docs/setup/extensions/python-markdown.md b/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,
diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 status: new
 ---
 
diff --git a/docs/setup/setting-up-navigation.md b/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 
diff --git a/docs/setup/setting-up-site-analytics.md b/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
diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md
@@ -1,5 +1,4 @@
 ---
-template: overrides/main.html
 search:
   boost: 1.05
 ---
diff --git a/docs/setup/setting-up-social-cards.md b/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
diff --git a/docs/setup/setting-up-tags.md b/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,
diff --git a/docs/setup/setting-up-the-footer.md b/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
diff --git a/docs/setup/setting-up-the-header.md b/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 
diff --git a/docs/setup/setting-up-versioning.md b/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
diff --git a/docs/upgrade.md b/docs/upgrade.md
@@ -1,7 +1,3 @@
----
-template: overrides/main.html
----
-
 # How to upgrade
 
 Upgrade to the latest version with:
diff --git a/material/overrides/blog.html b/material/overrides/blog.html
diff --git a/material/overrides/main.html b/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>
diff --git a/material/overrides/partials/content.html b/material/overrides/partials/content.html
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/src/overrides/blog.html b/src/overrides/blog.html
diff --git a/src/overrides/main.html b/src/overrides/main.html
diff --git a/src/overrides/partials/content.html b/src/overrides/partials/content.html
