1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-01 02:27:17 +01:00
mkdocs-material/src/base.html

415 lines
13 KiB
HTML
Raw Normal View History

2016-08-07 18:01:56 +02:00
<!--
Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
2016-08-07 18:01:56 +02:00
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.
-->
{% import "partials/language.html" as lang with context %}
2017-01-06 19:18:17 +01:00
2017-10-31 17:03:42 +01:00
<!-- Theme options -->
{% set feature = config.theme.feature %}
{% set palette = config.theme.palette %}
{% set font = config.theme.font %}
2017-10-31 17:03:42 +01:00
<!doctype html>
<html lang="{{ lang.t('language') }}" class="no-js">
2016-01-28 23:27:15 +01:00
<head>
2017-09-01 10:07:29 +02:00
<!-- Metatags -->
{% block site_meta %}
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<!-- Keep for compatibility, see http://bit.ly/2tMB6ag -->
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<!-- Page description -->
{% if page and page.meta and page.meta.description %}
<meta name="description" content="{{ page.meta.description }}" />
{% elif config.site_description %}
<meta name="description" content="{{ config.site_description }}" />
{% endif %}
2018-12-28 15:09:11 +01:00
<!-- Redirect -->
{% if page and page.meta and page.meta.redirect %}
2018-12-28 15:09:11 +01:00
<script>
var anchor = window.location.hash.substr(1)
location.href = '{{ page.meta.redirect }}' +
(anchor ? '#' + anchor : '')
</script>
2019-11-26 10:36:04 +01:00
<!-- Fallback in case JavaScript is not available -->
2018-12-28 15:09:11 +01:00
<meta http-equiv="refresh" content="0; url={{ page.meta.redirect }}" />
<meta name="robots" content="noindex" />
<link rel="canonical" href="{{ page.meta.redirect }}" />
<!-- Canonical -->
{% elif page.canonical_url %}
<link rel="canonical" href="{{ page.canonical_url }}" />
{% endif %}
<!-- Page author -->
{% if page and page.meta and page.meta.author %}
<meta name="author" content="{{ page.meta.author }}" />
{% elif config.site_author %}
<meta name="author" content="{{ config.site_author }}" />
{% endif %}
<!-- Favicon -->
<link rel="shortcut icon" href="{{ config.theme.favicon | url }}">
<!-- Generator banner -->
<meta
name="generator"
content="mkdocs-{{ mkdocs_version }}, $md-name$-$md-version$"
/>
{% endblock %}
2017-09-01 10:07:29 +02:00
<!-- Site title -->
{% block htmltitle %}
{% if page and page.meta and page.meta.title %}
<title>{{ page.meta.title }}</title>
{% elif page and page.title and not page.is_homepage %}
<title>{{ page.title | striptags }} - {{ config.site_name }}</title>
{% else %}
<title>{{ config.site_name }}</title>
{% endif %}
{% endblock %}
2019-11-26 10:36:04 +01:00
<!-- Theme-related stylesheets -->
{% block styles %}
<link
rel="stylesheet"
type="text/css"
2020-02-10 18:32:28 +01:00
href="{{ 'assets/stylesheets/app.scss' | url }}"
/>
2017-02-10 16:43:32 +01:00
<!-- Extra color palette -->
{% if palette.primary or palette.accent %}
<link
rel="stylesheet"
type="text/css"
2020-02-10 18:32:28 +01:00
href="{{ 'assets/stylesheets/app-palette.scss' | url }}"
/>
{% endif %}
<!-- Theme-color meta tag for Android -->
{% if palette.primary %}
{% import "partials/palette.html" as map %}
{% set primary = map.primary(
palette.primary | replace(" ", "-") | lower
) %}
<meta name="theme-color" content="{{ primary }}" />
{% endif %}
{% endblock %}
2017-02-10 16:43:32 +01:00
2017-11-01 18:25:08 +01:00
<!-- JavaScript libraries -->
2019-09-28 20:39:07 +02:00
{% block libs %}{% endblock %}
2017-11-01 18:25:08 +01:00
2017-09-01 10:07:29 +02:00
<!-- Webfonts -->
{% block fonts %}
<!-- Load fonts from Google -->
{% if font != false %}
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin />
<link
rel="stylesheet"
type="text/css"
href="https://fonts.googleapis.com/css?family={{
font.text | replace(' ', '+') + ':300,400,400i,700%7C' +
font.code | replace(' ', '+')
}}&display=fallback"
/>
2017-01-13 00:31:37 +01:00
<style>
body, input {
2017-10-31 18:21:09 +01:00
font-family: "{{ font.text }}", "Helvetica Neue",
2017-01-13 00:31:37 +01:00
Helvetica, Arial, sans-serif;
}
pre, code, kbd {
2017-10-31 18:21:09 +01:00
font-family: "{{ font.code }}", "Courier New",
2017-01-13 00:31:37 +01:00
Courier, monospace;
}
</style>
{% endif %}
{% endblock %}
<!-- Progressive Web App Manifest -->
{% if config.extra.manifest %}
2019-12-25 15:14:02 +01:00
<link
rel="manifest"
type="application/manifest+json"
href="{{ config.extra.manifest | url }}"
crossorigin="use-credentials"
/>
{% endif %}
2017-02-10 16:43:32 +01:00
<!-- Custom stylesheets -->
{% for path in config["extra_css"] %}
2018-08-04 19:53:13 +02:00
<link rel="stylesheet" type="text/css" href="{{ path | url }}" />
{% endfor %}
2019-11-26 10:36:04 +01:00
<!-- Analytics -->
{% block analytics %}
{% if config.google_analytics %}
{% include "partials/integrations/analytics.html" %}
{% endif %}
{% endblock %}
2019-01-28 11:18:22 +01:00
2017-09-01 10:07:29 +02:00
<!-- Custom front matter -->
{% block extrahead %}{% endblock %}
2016-01-28 23:27:15 +01:00
</head>
2016-12-17 12:53:24 +01:00
<!-- Text direction and color palette, if defined -->
{% if palette.primary or palette.accent %}
{% set primary = palette.primary | replace(" ", "-") | lower %}
{% set accent = palette.accent | replace(" ", "-") | lower %}
<body
dir="{{ lang.t('direction') }}"
data-md-color-primary="{{ primary }}"
data-md-color-accent="{{ accent }}"
>
{% else %}
2018-02-01 22:57:00 +01:00
<body dir="{{ lang.t('direction') }}">
{% endif %}
2016-01-28 23:27:15 +01:00
<!--
State toggles - we need to set autocomplete="off" in order to reset the
drawer on back button invocation in some browsers
-->
<input
class="md-toggle"
data-md-toggle="drawer"
type="checkbox"
id="__drawer"
autocomplete="off"
/>
<input
class="md-toggle"
data-md-toggle="search"
type="checkbox"
id="__search"
autocomplete="off"
/>
2016-01-28 23:27:15 +01:00
<!-- Overlay for expanded drawer -->
2019-12-22 17:30:55 +01:00
<label class="md-overlay" for="__drawer"></label>
2016-01-28 23:27:15 +01:00
2019-11-26 10:36:04 +01:00
<!-- Link to skip to content -->
{% if page.toc | first is defined %}
Merge branch 'master' into refactor/rxjs-typescript (#1406) * Improved Lighthouse score (#1391) * a few accessibility fixes from lighthouse report * add rel="noopener" to external links * add title attribute to social links * add mimetype to manifest link and allow it to work behind auth * add font-display: swap to all the places where external fonts are used * remove font-display: swap from icon fonts * removed font-display from style blocks in base * add target="_blank" to social links * switch base fonts grabbed from Google back to display:fallback As per recommendation from https://developers.google.com/web/updates/2016/02/font-display#fallback * add target="_blank" to the footer links as well * Set `tabindex` to `0` for skip to content link (#1393) see https://web.dev/control-focus-with-tabindex/ * Added diff to CI build * Added built files * Bump @babel/cli from 7.7.5 to 7.7.7 Bumps [@babel/cli](https://github.com/babel/babel) from 7.7.5 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.5...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump css-loader from 3.3.2 to 3.4.0 Bumps [css-loader](https://github.com/webpack-contrib/css-loader) from 3.3.2 to 3.4.0. - [Release notes](https://github.com/webpack-contrib/css-loader/releases) - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/css-loader/compare/v3.3.2...v3.4.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump eslint from 6.7.2 to 6.8.0 Bumps [eslint](https://github.com/eslint/eslint) from 6.7.2 to 6.8.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v6.7.2...v6.8.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump mini-css-extract-plugin from 0.8.0 to 0.9.0 Bumps [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin) from 0.8.0 to 0.9.0. - [Release notes](https://github.com/webpack-contrib/mini-css-extract-plugin/releases) - [Changelog](https://github.com/webpack-contrib/mini-css-extract-plugin/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/mini-css-extract-plugin/compare/v0.8.0...v0.9.0) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/plugin-transform-react-jsx from 7.7.4 to 7.7.7 Bumps [@babel/plugin-transform-react-jsx](https://github.com/babel/babel) from 7.7.4 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.4...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump style-loader from 1.0.1 to 1.1.1 Bumps [style-loader](https://github.com/webpack-contrib/style-loader) from 1.0.1 to 1.1.1. - [Release notes](https://github.com/webpack-contrib/style-loader/releases) - [Changelog](https://github.com/webpack-contrib/style-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/style-loader/compare/v1.0.1...v1.1.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump webpack from 4.41.2 to 4.41.4 Bumps [webpack](https://github.com/webpack/webpack) from 4.41.2 to 4.41.4. - [Release notes](https://github.com/webpack/webpack/releases) - [Commits](https://github.com/webpack/webpack/compare/v4.41.2...v4.41.4) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/core from 7.7.5 to 7.7.7 Bumps [@babel/core](https://github.com/babel/babel) from 7.7.5 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.5...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Bump @babel/preset-env from 7.7.6 to 7.7.7 Bumps [@babel/preset-env](https://github.com/babel/babel) from 7.7.6 to 7.7.7. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/master/CHANGELOG.md) - [Commits](https://github.com/babel/babel/compare/v7.7.6...v7.7.7) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Fix makefile * Update packages * build * "Fix" lint * Revert icon and makefile change Co-authored-by: Martin Donath <squidfunk@users.noreply.github.com> Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2019-12-25 15:09:36 +01:00
<a href="{{ (page.toc | first).url }}" tabindex="0" class="md-skip">
2018-01-18 21:19:10 +01:00
{{ lang.t('skip.link.title') }}
</a>
{% endif %}
2020-01-25 14:26:06 +01:00
<!-- Announcement bar -->
{% if self.announcement() %}
2020-01-25 15:09:27 +01:00
<aside class="md-announcement" data-md-component="announcement">
<div class="md-announcement__inner md-grid md-typeset">
{% block announcement %}{% endblock %}
</div>
</aside>
2020-01-25 14:26:06 +01:00
{% endif %}
2018-01-18 21:19:10 +01:00
2016-08-07 18:01:56 +02:00
<!-- Application header -->
{% block header %}
{% include "partials/header.html" %}
{% endblock %}
2016-01-28 23:27:15 +01:00
2016-08-07 18:01:56 +02:00
<!-- Container, necessary for web-application context -->
2019-11-22 17:53:12 +01:00
<div class="md-container" data-md-component="container">
2017-11-22 00:13:56 +01:00
<!-- Hero teaser -->
{% block hero %}
{% if page and page.meta and page.meta.hero %}
{% include "partials/hero.html" with context %}
{% endif %}
{% endblock %}
2017-11-22 00:13:56 +01:00
<!-- Tabs with outline -->
2020-02-13 10:10:04 +01:00
{% block tabs %}
{% if feature.tabs %}
{% include "partials/tabs.html" %}
{% endif %}
{% endblock %}
2019-11-26 10:36:04 +01:00
<!-- Main area -->
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
2016-01-28 23:27:15 +01:00
2017-09-01 10:07:29 +02:00
<!-- Navigation -->
{% block site_nav %}
<!-- Main navigation -->
{% if nav %}
<div
class="md-sidebar md-sidebar--primary"
data-md-component="navigation"
>
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
{% include "partials/nav.html" %}
</div>
2016-09-23 11:56:25 +02:00
</div>
</div>
{% endif %}
<!-- Table of contents -->
{% if page.toc %}
<div
class="md-sidebar md-sidebar--secondary"
data-md-component="toc"
>
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
{% include "partials/toc.html" %}
</div>
2016-09-23 11:56:25 +02:00
</div>
</div>
{% endif %}
{% endblock %}
2016-01-28 23:27:15 +01:00
2016-08-07 18:01:56 +02:00
<!-- Article -->
2016-09-23 20:26:27 +02:00
<div class="md-content">
<article class="md-content__inner md-typeset">
2017-09-01 10:07:29 +02:00
<!-- Content -->
{% block content %}
2017-03-01 15:43:49 +01:00
<!-- Edit button, if URL was defined -->
{% if page.edit_url %}
<a
href="{{ page.edit_url }}"
title="{{ lang.t('edit.link.title') }}"
class="md-icon md-content__icon"
>&#xE3C9;<!-- edit --></a>
{% endif %}
2017-03-01 15:43:49 +01:00
<!--
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 | default(config.site_name, true)}}</h1>
{% endif %}
2016-09-23 11:56:25 +02:00
<!-- Content -->
{{ page.content }}
<!-- Source files -->
{% block source %}
{% if page and page.meta and page.meta.source %}
<h2 id="__source">{{ lang.t("meta.source") }}</h2>
{% set repo = config.repo_url %}
{% if repo | last == "/" %}
{% set repo = repo[:-1] %}
{% endif %}
{% set path = page.meta.path | default([""]) %}
{% set file = page.meta.source %}
<a
href="{{ [repo, path, file] | join('/') }}"
title="{{ file }}"
class="md-source-file"
>
{{ file }}
</a>
{% endif %}
{% endblock %}
<!-- Support for mkdocs-git-revision-date-localized-plugin -->
{% if page and page.meta and (
page.meta.git_revision_date_localized or
page.meta.revision_date
) %}
{% set label = lang.t("source.revision.date") %}
<hr />
<div class="md-source-date">
<small>
<!-- mkdocs-git-revision-date-localized-plugin -->
{% if page.meta.git_revision_date_localized %}
{{ label }}: {{ page.meta.git_revision_date_localized }}
<!-- mkdocs-git-revision-date-plugin -->
{% elif page.meta.revision_date %}
{{ label }}: {{ page.meta.revision_date }}
{% endif %}
</small>
</div>
{% endif %}
{% endblock %}
2017-02-24 22:53:12 +01:00
<!-- Disqus integration -->
{% block disqus %}
{% include "partials/integrations/disqus.html" %}
{% endblock %}
2016-08-07 18:01:56 +02:00
</article>
2016-01-28 23:27:15 +01:00
</div>
</div>
2016-08-07 18:01:56 +02:00
</main>
<!-- Application footer -->
{% block footer %}
{% include "partials/footer.html" %}
{% endblock %}
2016-08-07 18:01:56 +02:00
</div>
2016-01-28 23:27:15 +01:00
2017-09-01 10:07:29 +02:00
<!-- Theme-related JavaScript -->
{% block scripts %}
<script src="{{ 'assets/javascripts/bundle.js' | url }}"></script>
2017-06-01 00:40:10 +02:00
<!-- Translations -->
<script id="__lang" type="application/json">
2019-11-26 10:19:10 +01:00
{%- set translations = {} -%}
{%- for key in [
"clipboard.copy",
"clipboard.copied",
"search.language",
"search.pipeline.stopwords",
"search.pipeline.trimmer",
"search.result.placeholder",
2019-11-26 10:19:10 +01:00
"search.result.none",
"search.result.one",
"search.result.other",
"search.tokenizer"
] -%}
{%- set _ = translations.update({ key: lang.t(key) }) -%}
{%- endfor -%}
{{ translations | tojson }}
</script>
2019-11-26 10:36:04 +01:00
<!-- Application initialization -->
<script>
2019-11-27 19:12:49 +01:00
app = initialize({
base: "{{ base_url }}",
worker: {
2019-12-22 17:18:20 +01:00
search: "{{ 'assets/javascripts/worker/search.js' | url }}",
packer: "{{ 'assets/javascripts/worker/packer.js' | url }}"
}
2017-10-22 21:22:25 +02:00
});
</script>
2019-11-26 10:36:04 +01:00
<!-- Custom JavaScript -->
{% for path in config["extra_javascript"] %}
2018-08-04 19:53:13 +02:00
<script src="{{ path | url }}"></script>
{% endfor %}
{% endblock %}
2016-01-28 23:27:15 +01:00
</body>
2016-09-23 11:56:25 +02:00
</html>