OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improved extensibility by restructuring template blocks

Browse Source
This commit is contained in:
squidfunk 2021-11-13 13:08:22 +01:00
parent 53aece0bf3
commit 6db782a64c
16 changed files with 171 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
material/base.html
View File

@ -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 %}
<a href="{{ page.edit_url }}" title="{{ lang.t('edit.link.title') }}" class="md-content__button md-icon">
{% include ".icons/material/pencil.svg" %}
</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" %}
{% include "partials/page-header.html" %}
{% include "partials/page.html" %}
{% include "partials/page-footer.html" %}
{% endblock %}
</article>
</div>

2
material/partials/footer.html
View File

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

0
material/partials/outdated.html → material/partials/javascripts/outdated.html
View File

12
material/partials/page-footer.html Normal file
View File

@ -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 %}

8
material/partials/page-header.html Normal file
View File

@ -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 %}

7
material/partials/page.html Normal file
View File

@ -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 }}

8
material/partials/social.html
View File

@ -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 %}
{% set title = social.name %}
{% if not title and "//" in social.link %}
{% set _,url = social.link.split("//") %}
{% set _, url = social.link.split("//") %}
{% set title = url.split("/")[0] %}
{% endif %}
<a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ title | e }}" class="md-footer-social__link">
{% include ".icons/" ~ social.icon ~ ".svg" %}
</a>
{% endfor %}
</div>
{% endif %}
</div>

2
material/partials/source-file.html
View File

@ -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") }}:

43
src/base.html
View File

@ -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 %}
<!-- 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 %}
<!--
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" %}
{% include "partials/page-header.html" %}
{% include "partials/page.html" %}
{% include "partials/page-footer.html" %}
{% endblock %}
</article>
</div>

2
src/partials/footer.html
View File

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

0
src/partials/outdated.html → src/partials/javascripts/outdated.html
View File

34
src/partials/page-footer.html Normal file
View File

@ -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 %}

32
src/partials/page-header.html Normal file
View File

@ -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 %}

33
src/partials/page.html Normal file
View File

@ -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 }}

8
src/partials/social.html
View File

@ -21,12 +21,11 @@
-->
<!-- Social links in footer -->
{% if config.extra.social %}
<div class="md-footer-social">
<div class="md-footer-social">
{% for social in config.extra.social %}
{% set title = social.name %}
{% if not title and "//" in social.link %}
{% set _,url = social.link.split("//") %}
{% set _, url = social.link.split("//") %}
{% set title = url.split("/")[0] %}
{% endif %}
<a
@ -38,5 +37,4 @@
{% include ".icons/" ~ social.icon ~ ".svg" %}
</a>
{% endfor %}
</div>
{% endif %}
</div>

4
src/partials/source-file.html
View File

@ -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 -->