mkdocs-material/src/base.html
2016-09-23 11:56:25 +02:00

182 lines
6.1 KiB
HTML

<!--
Copyright (c) 2016 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.
-->
<!DOCTYPE html>
<html class="no-js">
<head>
<!-- Charset and viewport -->
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,
user-scalable=no, initial-scale=1, maximum-scale=1" />
<!-- Site title -->
{% if page_title %}
<title>{{ page_title }} - {{ site_name }}</title>
{% elif page_description %}
<title>{{ site_name }} - {{ page_description }}</title>
{% else %}
<title>{{ site_name }}</title>
{% endif %}
<!-- Site description -->
{% if page_description %}
<meta name="description" content="{{ page_description }}" />
{% endif %}
<!-- Canonical -->
{% if canonical_url %}
<link rel="canonical" href="{{ canonical_url }}" />
{% endif %}
<!-- Author -->
{% if site_author %}
<meta name="author" content="{{ site_author }}" />
{% endif %}
<!-- Generator banner -->
<meta name="generator" content="mkdocs+$theme-name$#$theme-version$" />
<!-- Modernizr -->
<script src="{{ base_url }}/assets/javascripts/modernizr.js"></script>
<!-- Web fonts -->
<link rel="stylesheet" type="text/css"
href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700" />
<link rel="stylesheet" type="text/css"
href="https://fonts.googleapis.com/css?family=Roboto+Mono:400" />
<link rel="stylesheet" type="text/css"
href="https://fonts.googleapis.com/icon?family=Material+Icons">
<!-- Theme-related stylesheets -->
<link rel="stylesheet" type="text/css"
href="{{ base_url }}/assets/stylesheets/application.css" />
<!-- Custom stylesheets -->
{% for path in extra_css %}
<link rel="stylesheet" type="text/css" href="{{ path }}" />
{% endfor %}
</head>
<body>
<!-- State toggles -->
<input class="md-toggle md-toggle--drawer" type="checkbox" id="drawer" />
<input class="md-toggle md-toggle--search" type="checkbox" id="search" />
<!-- Overlay for expanded drawer -->
<label class="md-overlay" for="drawer"></label>
<!-- Application header -->
{% include "partials/header.html" %}
<!-- Container, necessary for web-application context -->
<div class="md-container">
<!-- Main container -->
<main class="md-main">
<div class="md-main__inner md-grid">
<!--
This is a nasty hack that checks whether the content contains a
h1 headline. If it does, the variable h1 is set to true. This is
necessary for correctly rendering the table of contents which is
embedded into the navigation and the actual headline.
-->
{% set h1 = "\x3ch1 id=" in content %}
<!-- Main navigation -->
{% if nav %}
<div class="md-sidebar md-sidebar--primary md-js__sidebar">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
{% include "partials/nav.html" %}
</div>
</div>
</div>
{% endif %}
<!-- Table of contents -->
{% if toc %}
<div class="md-sidebar md-sidebar--secondary md-js__sidebar">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
{% include "partials/toc.html" %}
</div>
</div>
</div>
{% endif %}
<!-- Article -->
<div class="md-content md-content--typeset">
<article class="md-content__inner">
<!-- Content block -->
{% block content %}
<!-- Edit button, if URL was defined -->
{% if edit_uri %}
<a class="md-button md-button--edit" href="{{ edit_uri }}">
Edit
</a>
{% endif %}
<!-- Content -->
{{ content }}
{% endblock %}
<!-- Copyright and theme information -->
<hr />
<small class="md-content__copyright">
{% if copyright %}
{{ copyright }} &ndash;
{% endif %}
This document was created with
<a href="http://www.mkdocs.org">
MkDocs
</a>
and the
<a href="http://squidfunk.github.io/mkdocs-material/">
Material
</a>
theme.
</small>
</article>
</div>
</div>
</main>
<!-- Application footer -->
{% include "partials/footer.html" %}
</div>
<!-- Theme-related and custom javascripts -->
<script>
var base_url = '{{ base_url }}';
var repo_url = '{{ repo_url }}';
</script>
<script src="{{ base_url }}/assets/javascripts/application.js"></script>
{% for path in extra_javascript %}
<script src="{{ path }}"></script>
{% endfor %}
</body>
</html>