diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index e5471c10e10..f644c6b3948 100644 --- 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 index 77a8dd274c1..f3afe6dcbe2 100644 --- 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 index 11879b70617..e5e3cece8a2 100644 --- 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 index 8fbc1513ad3..acf3dd48732 100644 --- 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 index 6bab4ea0814..c8123802bb7 100644 --- 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 index 58f469d3a33..e7e4baa05b5 100644 --- 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 index a0bb59369dd..12215786a56 100644 --- 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 index ad49ab43721..ff0136314ae 100644 --- 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. \ No newline at end of file diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 3e3a2634997..5e8d179df26 100644 --- 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 index 42d1f5a9c31..8b8157dfe95 100644 --- 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 index 1df8c74d7bc..a77ceb4a951 100644 --- 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 index bb0712d7628..7f736e77baa 100644 --- 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 index 6821c121c5b..41a01ca1e8f 100644 --- 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 index faeec48ae34..6090e6ce62c 100644 --- 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 index 15408aef719..f2121ed5c9b 100644 --- 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 index db02e514e42..8d15e3d07cd 100644 --- 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 index 4e72eb0d1f2..72b8dcbc7ad 100644 --- 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 index be358e8f9b1..c2f09a535e3 100644 --- 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 index 7e15ecf9db4..15fe47c73c6 100644 --- 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 index 100cecc34b1..03b91d6a968 100644 --- 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 index 590600f67bf..d6ce3a99592 100644 --- 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 index c5a4aa470da..16380c2cb2b 100644 --- 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 index f3ca2e42873..7dec1ca6997 100644 --- 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 index 6c45543421d..021394d3fe7 100644 --- 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 index e2d82414178..2bae6e6a708 100644 --- 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 index 88192bd9c08..cbb30f2bb52 100644 --- 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 index 08e8beb12e7..4cd5b624752 100644 --- 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 index d73885b0001..5883002a7be 100644 --- 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 index 960828465d9..f4107440216 100644 --- 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 index efdebb33938..5b4e7f64292 100644 --- 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 index fd91ed30ad6..9fad62546d7 100644 --- 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 index e4ec5a7b988..e14cf940a8d 100644 --- 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 index 038fb13203b..1ff53c1d617 100644 --- 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 index a40d45aa865..55c880123b3 100644 --- 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 index ab8a5d2393f..b671376afd0 100644 --- 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 index 598f53dd55d..7cdf1d58790 100644 --- 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 index 57cbcc9c670..1478fa488d7 100644 --- 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 index 198398fa735..c295940d61a 100644 --- 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 index 8fd02f6e36a..db440bc340b 100644 --- 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 index c32c410b04a..4e3e744dae0 100644 --- 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 index 4278116d180..0c581b6a7b6 100644 --- 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 index 362932fb8b5..5162bffe719 100644 --- 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 index d1863861e84..0ac14e9e3d4 100644 --- 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 index 50371d093ed..9ec16ca0cff 100644 --- 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 index 93a1f439061..e829138ff4e 100644 --- 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 index e11a184eb91..b89206d23c5 100644 --- 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 index ef53fdc4468..9ef2a659d09 100644 --- 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 index 2fc2cc0572f..c0954be620b 100644 --- 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 index b119cc85ea5..9a90094367c 100644 --- 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 index 4641dbc232f..aee3acaf486 100644 --- 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 index 5fb030cebe9..fe9ad9ab1b2 100644 --- 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 deleted file mode 100644 index 609da25882b..00000000000 --- a/material/overrides/blog.html +++ /dev/null @@ -1,10 +0,0 @@ -{#- - This file was automatically generated - do not edit --#} -{% extends "overrides/main.html" %} -{% block content %} - {{ super() }} -

{{ lang.t("meta.comments") }}

- - -{% endblock %} diff --git a/material/overrides/main.html b/material/overrides/main.html index d61ab0c8329..f414b841fea 100644 --- a/material/overrides/main.html +++ b/material/overrides/main.html @@ -14,9 +14,6 @@ Twitter {% endblock %} -{% block content %} - {% include "overrides/partials/content.html" %} -{% endblock %} {% block scripts %} {{ super() }} diff --git a/material/overrides/partials/content.html b/material/overrides/partials/content.html deleted file mode 100644 index 10acfc0cc03..00000000000 --- a/material/overrides/partials/content.html +++ /dev/null @@ -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 %} -

{{ page.title | d(config.site_name, true)}}

-{% 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" %} diff --git a/mkdocs.yml b/mkdocs.yml index 603dcec3eaf..341d58b67e2 100755 --- a/mkdocs.yml +++ b/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 diff --git a/src/overrides/blog.html b/src/overrides/blog.html deleted file mode 100644 index ddbd3ed802c..00000000000 --- a/src/overrides/blog.html +++ /dev/null @@ -1,76 +0,0 @@ - - -{% extends "overrides/main.html" %} - - -{% block content %} - {{ super() }} - - -

{{ lang.t("meta.comments") }}

- - - - -{% endblock %} diff --git a/src/overrides/main.html b/src/overrides/main.html index 5aeb7e2941a..88a14e8f732 100644 --- a/src/overrides/main.html +++ b/src/overrides/main.html @@ -43,11 +43,6 @@ {% endblock %} - -{% block content %} - {% include "overrides/partials/content.html" %} -{% endblock %} - {% block scripts %} {{ super() }} diff --git a/src/overrides/partials/content.html b/src/overrides/partials/content.html deleted file mode 100644 index b954431ade5..00000000000 --- a/src/overrides/partials/content.html +++ /dev/null @@ -1,51 +0,0 @@ - - - -{% if "tags" in config.plugins %} - {% include "partials/tags.html" %} -{% endif %} - - -{% include "overrides/partials/actions.html" %} - - -{% if not "\x3ch1" in page.content %} -

{{ page.title | d(config.site_name, true)}}

-{% 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" %}