mkdocs-material/src/overrides/main.html

<!--
  Copyright (c) 2016-2020 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 "base.html" %}

<!-- Custom front matter -->
{% block extrahead %}

  <!-- Determine title -->
  {% set title = config.site_name %}
  {% if page and page.title and not page.is_homepage %}
    {% set title = config.site_name ~ " - " ~ page.title | striptags %}
  {% endif %}

  <!-- The image needs to have an absolute URL -->
  {% set image = config.site_url ~ 'assets/images/banner.png' %}

  <!-- Open graph meta tags -->
  <meta property="og:type" content="website" />
  <meta property="og:title" content="{{ title }}" />
  <meta property="og:description" content="{{ config.site_description }}" />
  <meta property="og:url" content="{{ page.canonical_url }}" />
  <meta property="og:image" content="{{ image }}" />
  <meta property="og:image:type" content="image/png" />
  <meta property="og:image:width" content="1080" />
  <meta property="og:image:height" content="568" />

  <!-- Twitter meta tags -->
  <meta name="twitter:card" content="summary_large_image" />
  <meta name="twitter:site" content="@squidfunk" />
  <meta name="twitter:creator" content="@squidfunk" />
  <meta name="twitter:title" content="{{ title }}" />
  <meta name="twitter:description" content="{{ config.site_description }}" />
  <meta name="twitter:image" content="{{ image }}" />

  <!-- Extra stylesheets -->
  <link
    rel="stylesheet"
    href="{{ 'overrides/assets/stylesheets/main.css' | url }}"
  />
{% endblock %}

<!-- Announcement bar -->
{% block announce %}
  <a href="https://twitter.com/squidfunk">
    For updates follow <strong>@squidfunk</strong> on
    <span class="twemoji twitter">
      {% include ".icons/fontawesome/brands/twitter.svg" %}
    </span>
    <strong>Twitter</strong>
  </a>
{% endblock %}

<!-- Content -->
{% block content %}
  {{ super() }}

  <!-- Content footer -->
  <footer class="tx-content__footer md-typeset">
    <a href="{{ 'insiders/' | url }}" title="Material for MkDocs Insiders">
      <hr />
      <span class="twemoji">
        {% include ".icons/logo.svg" %}
      </span>
      <span class="twemoji">
        {% include ".icons/material/plus.svg" %}
      </span>
      <span class="twemoji tx-heart">
        {% include ".icons/octicons/heart-fill-24.svg" %}
      </span>
      <hr />
    </a>
  </footer>
{% endblock %}

<!-- Theme-related JavaScript -->
{% block scripts %}
  {{ super() }}

  <!-- Extra JavaScript -->
  <script src="{{ 'overrides/assets/javascripts/vendor.js' | url }}"></script>
  <script src="{{ 'overrides/assets/javascripts/bundle.js' | url }}"></script>
{% endblock %}