Update mkdoc config
This commit is contained in:
Gauthier Provost
parent
e2bd20cd43
commit
9c220d2ccb
2 changed files with 5 additions and 199 deletions
|
|
@ -14,17 +14,18 @@ copyright: 'Copyright © Kobol Team 2017'
|
||||||
# Documentation and theme
|
# Documentation and theme
|
||||||
theme:
|
theme:
|
||||||
name: 'material'
|
name: 'material'
|
||||||
|
favicon: './img/favicon.png'
|
||||||
custom_dir: 'theme'
|
custom_dir: 'theme'
|
||||||
|
|
||||||
# Options
|
|
||||||
extra:
|
|
||||||
logo: './img/helios4_logo.png'
|
|
||||||
palette:
|
palette:
|
||||||
primary: 'teal'
|
primary: 'teal'
|
||||||
accent: 'pink'
|
accent: 'pink'
|
||||||
font:
|
font:
|
||||||
text: 'Roboto'
|
text: 'Roboto'
|
||||||
code: 'Roboto Mono'
|
code: 'Roboto Mono'
|
||||||
|
|
||||||
|
# Options
|
||||||
|
extra:
|
||||||
|
logo: './img/helios4_logo.png'
|
||||||
social:
|
social:
|
||||||
- type: 'home'
|
- type: 'home'
|
||||||
link: 'https://kobol.io/helios4'
|
link: 'https://kobol.io/helios4'
|
||||||
|
|
|
||||||
195
theme/base.html
195
theme/base.html
|
|
@ -1,195 +0,0 @@
|
||||||
{% import "partials/language.html" as lang with context %}
|
|
||||||
{% set feature = config.theme.feature %}
|
|
||||||
{% set palette = config.theme.palette %}
|
|
||||||
{% set font = config.theme.font %}
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="{{ lang.t('language') }}" class="no-js">
|
|
||||||
<head>
|
|
||||||
{% block site_meta %}
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
||||||
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
||||||
{% if page and page.meta.description %}
|
|
||||||
<meta name="description" content="{{ page.meta.description }}">
|
|
||||||
{% elif config.site_description %}
|
|
||||||
<meta name="description" content="{{ config.site_description }}">
|
|
||||||
{% endif %}
|
|
||||||
{% if page.canonical_url %}
|
|
||||||
<link rel="canonical" href="{{ page.canonical_url }}">
|
|
||||||
{% endif %}
|
|
||||||
{% if page and page.meta.author %}
|
|
||||||
<meta name="author" content="{{ page.meta.author | first }}">
|
|
||||||
{% elif config.site_author %}
|
|
||||||
<meta name="author" content="{{ config.site_author }}">
|
|
||||||
{% endif %}
|
|
||||||
{% for key in [
|
|
||||||
"clipboard.copy",
|
|
||||||
"clipboard.copied",
|
|
||||||
"search.language",
|
|
||||||
"search.result.none",
|
|
||||||
"search.result.one",
|
|
||||||
"search.result.other",
|
|
||||||
"search.tokenizer"
|
|
||||||
] %}
|
|
||||||
<meta name="lang:{{ key }}" content="{{ lang.t(key) }}">
|
|
||||||
{% endfor %}
|
|
||||||
<link rel="shortcut icon" href="{{ base_url }}/img/favicon.png">
|
|
||||||
<meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-2.1.0">
|
|
||||||
{% endblock %}
|
|
||||||
{% block htmltitle %}
|
|
||||||
{% if page and page.meta.title %}
|
|
||||||
<title>{{ page.meta.title }}</title>
|
|
||||||
{% elif page and page.title and not page.is_homepage %}
|
|
||||||
<title>{{ page.title }} - {{ config.site_name }}</title>
|
|
||||||
{% else %}
|
|
||||||
<title>{{ config.site_name }}</title>
|
|
||||||
{% endif %}
|
|
||||||
{% endblock %}
|
|
||||||
{% block styles %}
|
|
||||||
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-3368aa6b74.css">
|
|
||||||
{% if palette.primary or palette.accent %}
|
|
||||||
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-95ad5566f9.palette.css">
|
|
||||||
{% endif %}
|
|
||||||
{% endblock %}
|
|
||||||
{% block libs %}
|
|
||||||
<script src="{{ base_url }}/assets/javascripts/modernizr-e826f8942a.js"></script>
|
|
||||||
{% endblock %}
|
|
||||||
{% block fonts %}
|
|
||||||
{% if font != false %}
|
|
||||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family={{
|
|
||||||
font.text | replace(' ', '+') + ':300,400,400i,700|' +
|
|
||||||
font.code | replace(' ', '+')
|
|
||||||
}}">
|
|
||||||
<style>body,input{font-family:"{{ font.text }}","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"{{ font.code }}","Courier New",Courier,monospace}</style>
|
|
||||||
{% endif %}
|
|
||||||
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
|
|
||||||
{% endblock %}
|
|
||||||
{% for path in extra_css %}
|
|
||||||
<link rel="stylesheet" href="{{ path }}">
|
|
||||||
{% endfor %}
|
|
||||||
{% block extrahead %}{% endblock %}
|
|
||||||
</head>
|
|
||||||
{% if palette.primary or palette.accent %}
|
|
||||||
{% set primary = palette.primary | replace(" ", "-") | lower %}
|
|
||||||
{% set accent = palette.accent | replace(" ", "-") | lower %}
|
|
||||||
{% if palette.primary and palette.accent %}
|
|
||||||
<body data-md-color-primary="{{ primary }}" data-md-color-accent="{{ accent }}">
|
|
||||||
{% elif palette.primary %}
|
|
||||||
<body data-md-color-primary="{{ primary }}">
|
|
||||||
{% elif palette.accent %}
|
|
||||||
<body data-md-color-accent="{{ accent }}">
|
|
||||||
{% endif %}
|
|
||||||
{% else %}
|
|
||||||
<body>
|
|
||||||
{% endif %}
|
|
||||||
<svg class="md-svg">
|
|
||||||
<defs>
|
|
||||||
{% set platform = config.extra.repo_icon or config.repo_url %}
|
|
||||||
{% if "github" in platform %}
|
|
||||||
{% include "assets/images/icons/github-1da075986e.svg" %}
|
|
||||||
{% elif "gitlab" in platform %}
|
|
||||||
{% include "assets/images/icons/gitlab-5ad3f9f9e5.svg" %}
|
|
||||||
{% elif "bitbucket" in platform %}
|
|
||||||
{% include "assets/images/icons/bitbucket-670608a71a.svg" %}
|
|
||||||
{% endif %}
|
|
||||||
</defs>
|
|
||||||
</svg>
|
|
||||||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
|
|
||||||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
|
|
||||||
<label class="md-overlay" data-md-component="overlay" for="drawer"></label>
|
|
||||||
{% block header %}
|
|
||||||
{% include "partials/header.html" %}
|
|
||||||
{% endblock %}
|
|
||||||
<div class="md-container">
|
|
||||||
{% if feature.tabs %}
|
|
||||||
{% include "partials/tabs.html" %}
|
|
||||||
{% endif %}
|
|
||||||
<main class="md-main">
|
|
||||||
<div class="md-main__inner md-grid" data-md-component="container">
|
|
||||||
{% block site_nav %}
|
|
||||||
{% 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>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
|
||||||
{% 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>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
|
||||||
{% endblock %}
|
|
||||||
<div class="md-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-icon md-content__icon"></a>
|
|
||||||
{% endif %}
|
|
||||||
{% if not "\x3ch1" in page.content %}
|
|
||||||
<h1>{{ page.title | default(config.site_name, true)}}</h1>
|
|
||||||
{% endif %}
|
|
||||||
{{ page.content }}
|
|
||||||
{% block source %}
|
|
||||||
{% if page.meta.source %}
|
|
||||||
<h2 id="__source">{{ lang.t("meta.source") }}</h2>
|
|
||||||
{% set path = page.meta.path | default([""]) %}
|
|
||||||
{% set file = page.meta.source %}
|
|
||||||
<a href="{{ [config.repo_url, path, file] | join('/') }}" title="{{ file }}" class="md-source-file">
|
|
||||||
{{ file }}
|
|
||||||
</a>
|
|
||||||
{% endif %}
|
|
||||||
{% endblock %}
|
|
||||||
{% endblock %}
|
|
||||||
{% block disqus %}
|
|
||||||
{% if config.extra.disqus and not page.is_homepage %}
|
|
||||||
<h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
|
|
||||||
{% include "partials/disqus.html" %}
|
|
||||||
{% endif %}
|
|
||||||
{% endblock %}
|
|
||||||
</article>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</main>
|
|
||||||
{% block footer %}
|
|
||||||
{% include "partials/footer.html" %}
|
|
||||||
{% endblock %}
|
|
||||||
</div>
|
|
||||||
{% block scripts %}
|
|
||||||
<script src="{{ base_url }}/assets/javascripts/application-a5397a53ce.js"></script>
|
|
||||||
{% if lang.t("search.language") != "en" %}
|
|
||||||
{% set languages = lang.t("search.language").split(",") %}
|
|
||||||
{% if languages | length and languages[0] != "" %}
|
|
||||||
{% set path = base_url + "/assets/javascripts/lunr" %}
|
|
||||||
<script src="{{ path }}/lunr.stemmer.support.js"></script>
|
|
||||||
{% for language in languages | map("trim") %}
|
|
||||||
{% if language != "en" %}
|
|
||||||
{% if language == "jp" %}
|
|
||||||
<script src="{{ path }}/tinyseg.js"></script>
|
|
||||||
{% endif %}
|
|
||||||
<script src="{{ path }}/lunr.{{ language }}.js"></script>
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
{% if languages | length > 1 %}
|
|
||||||
<script src="{{ path }}/lunr.multi.js"></script>
|
|
||||||
{% endif %}
|
|
||||||
{% endif %}
|
|
||||||
{% endif %}
|
|
||||||
<script>app.initialize({version:"{{ mkdocs_version }}",url:{base:"{{ base_url }}"}})</script>
|
|
||||||
{% for path in extra_javascript %}
|
|
||||||
<script src="{{ path }}"></script>
|
|
||||||
{% endfor %}
|
|
||||||
{% endblock %}
|
|
||||||
{% block analytics %}
|
|
||||||
{% if config.google_analytics %}
|
|
||||||
<script>!function(e,t,a,n,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","{{ config.google_analytics[0] }}","{{ config.google_analytics[1] }}"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
|
|
||||||
{% endif %}
|
|
||||||
{% endblock %}
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Loading…
Reference in a new issue