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

Added button to view source of every page

Browse Source
This commit is contained in:
squidfunk 2022-04-07 19:18:50 +02:00
parent 52adc006ba
commit d926bb4c27
7 changed files with 110 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
material/overrides/main.html
View File

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

26
material/overrides/partials/content.html Normal file
View File

@ -0,0 +1,26 @@
{#-
This file was automatically generated - do not edit
-#}
{% if page.edit_url %}
{% set edit = "https://github.com/squidfunk/mkdocs-material/edit" %}
{% set view = "https://raw.githubusercontent.com/squidfunk/mkdocs-material" %}
<a href="{{ page.edit_url }}" title="{{ lang.t('edit.link.title') }}" class="md-content__button md-icon">
{% include ".icons/material/file-edit-outline.svg" %}
</a>
<a href="{{ page.edit_url | replace(edit, view) }}" title="View source of this page" class="md-content__button md-icon">
{% include ".icons/material/file-eye-outline.svg" %}
</a>
{% endif %}
{% if "tags" in config.plugins %}
{% include "partials/tags.html" %}
{% 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 %}

6
material/partials/content.html
View File

@ -2,9 +2,9 @@
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>
<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 "tags" in config.plugins %}
{% include "partials/tags.html" %}

1
mkdocs.yml
View File

@ -29,7 +29,6 @@ site_description: >-
# Repository
repo_name: squidfunk/mkdocs-material
repo_url: https://github.com/squidfunk/mkdocs-material
edit_uri: ""
# Copyright
copyright: Copyright &copy; 2016 - 2022 Martin Donath

5
src/overrides/main.html
View File

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

66
src/overrides/partials/content.html Normal file
View File

@ -0,0 +1,66 @@
<!--
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.
-->
<!-- Edit and view button -->
{% if page.edit_url %}
{% set edit = "https://github.com/squidfunk/mkdocs-material/edit" %}
{% set view = "https://raw.githubusercontent.com/squidfunk/mkdocs-material" %}
<a
href="{{ page.edit_url }}"
title="{{ lang.t('edit.link.title') }}"
class="md-content__button md-icon"
>
{% include ".icons/material/file-edit-outline.svg" %}
</a>
<a
href="{{ page.edit_url | replace(edit, view) }}"
title="View source of this page"
class="md-content__button md-icon"
>
{% include ".icons/material/file-eye-outline.svg" %}
</a>
{% endif %}
<!-- Tags -->
{% if "tags" in config.plugins %}
{% include "partials/tags.html" %}
{% 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 }}
<!-- 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 %}

14
src/partials/content.html
View File

@ -22,13 +22,13 @@
<!-- 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>
<a
href="{{ page.edit_url }}"
title="{{ lang.t('edit.link.title') }}"
class="md-content__button md-icon"
>
{% include ".icons/material/pencil.svg" %}
</a>
{% endif %}
<!-- Tags -->