mirror of https://framagit.org/kyodev/kyopages.git
200 lines
5.5 KiB
HTML
200 lines
5.5 KiB
HTML
<!--
|
|
This Basic theme serves as an example for how to create other
|
|
themes by demonstrating the features with minimal HTML and CSS.
|
|
Comments like this will be through the code to explain briefly
|
|
what each feature is and point you to the MkDocs documentation
|
|
to find out more.
|
|
-->
|
|
<!DOCTYPE html>
|
|
<head>
|
|
|
|
<!--
|
|
The page_title contains the title for a page as shown in the navigation.
|
|
Site name contains the name as defined in the mkdocs.yml
|
|
-->
|
|
<title>{% if page_title %}{{ page_title }} - {% endif %}{{ site_name }}</title>
|
|
|
|
<!--
|
|
Support custom favicon support.
|
|
http://www.mkdocs.org/user-guide/configuration/#site_favicon
|
|
-->
|
|
{% if favicon %}
|
|
<link rel="shortcut icon" href="{{ favicon }}">
|
|
{% else %}
|
|
<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">
|
|
{% endif %}
|
|
|
|
<!--
|
|
You can include external assets of course, but be aware that it means the
|
|
documentation may not work well offline.
|
|
-->
|
|
<!--
|
|
<link rel="stylesheet" href="https://yui-s.yahooapis.com/pure/0.6.0/pure-min.css">
|
|
-->
|
|
|
|
<link rel="stylesheet" href="{{ base_url }}/css/theme.css">
|
|
|
|
<!--
|
|
extra_ess contains paths to CSS files in the users
|
|
documentation directory or a list of CSS files defined in
|
|
their mkdocs.yml.
|
|
|
|
http://www.mkdocs.org/user-guide/configuration/#extra_css
|
|
-->
|
|
{% for path in extra_css %}
|
|
<link href="{{ path }}" rel="stylesheet">
|
|
{% endfor %}
|
|
|
|
<!--
|
|
To include static assets from our theme, just add
|
|
{{ base_url }} beforehand which will be the relative path to
|
|
the root of the documentation.
|
|
-->
|
|
<script src="{{ base_url }}/js/theme.js"></script>
|
|
|
|
<!--
|
|
extra_javascript contains paths to JavaScript files in the
|
|
users documentation directory or a list of JavaScript files
|
|
defined in their mkdocs.yml.
|
|
|
|
http://www.mkdocs.org/user-guide/configuration/#extra_javascript
|
|
-->
|
|
{% for path in extra_javascript %}
|
|
<script src="{{ path }}"></script>
|
|
{% endfor %}
|
|
|
|
<!--
|
|
Include Google Analytics tracking code.
|
|
|
|
http://www.mkdocs.org/user-guide/configuration/#google_analytics
|
|
-->
|
|
{% if google_analytics %}
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', '{{ google_analytics[0] }}', '{{ google_analytics[1] }}');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
{% endif %}
|
|
|
|
{% block extrahead %}
|
|
{% endblock %}
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h1>This is an example theme for MkDocs.</h1>
|
|
|
|
<p>
|
|
It is designed to be read by looking at the theme HTML which is heavily
|
|
commented. The easiest way to do that is by
|
|
<strong><a href="https://github.com/mkdocs/mkdocs-basic-theme/tree/master/basic_theme">
|
|
looking at the source on GitHub.</a></strong>. Otherwise this is just a
|
|
demonstration that the theme is fully functional.
|
|
</p>
|
|
|
|
<hr/>
|
|
|
|
<h2>Documentation Navigation</h2>
|
|
|
|
<!--
|
|
Create the navigation for the documentation.
|
|
|
|
Because we don't know how many levels deep the navigation is, it needs to
|
|
be included in it's own file so it can be recursive. Otherwise the theme
|
|
can also only support a specific number of levels.
|
|
|
|
See the nav.html file for more details about how this works.
|
|
-->
|
|
<ul>
|
|
{% for nav_item in nav %}
|
|
{% include "nav.html" %}
|
|
{% endfor %}
|
|
</ul>
|
|
|
|
<hr/>
|
|
|
|
<h2>Support for search</h2>
|
|
<!--
|
|
Create a search form that sends the user to the search.html file - this is
|
|
the other file in the template which adds search to the theme. The only
|
|
requirement here is that there is a text input with the name 'q' and the
|
|
action and methods match below.
|
|
-->
|
|
<div role="search">
|
|
<form action="{{ base_url }}/search.html" method="get">
|
|
<input type="search" name="q" placeholder="Search docs" />
|
|
</form>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<h2>Next and previous links</h2>
|
|
<!--
|
|
Implement the previous and next links to cycle through the pages.
|
|
-->
|
|
{% if next_page or previous_page %}
|
|
<div>
|
|
{% if previous_page %}
|
|
<a href="{{ previous_page.url }}" title="{{ previous_page.title }}">← Previous Page</a>
|
|
{% else %}
|
|
← Previous Page
|
|
{% endif %}
|
|
-
|
|
{% if next_page %}
|
|
<a href="{{ next_page.url }}" title="{{ next_page.title }}"/>Next Page →</a>
|
|
{% else %}
|
|
Next Page →
|
|
{% endif %}
|
|
</div>
|
|
{% endif %}
|
|
|
|
<hr/>
|
|
|
|
<h2>Link to the source</h2>
|
|
<!--
|
|
Support repo URL
|
|
-->
|
|
{% if repo_url %}
|
|
{% if repo_name == 'GitHub' %}
|
|
<a href="{{ repo_url }}"> Edit on GitHub</a>
|
|
{% elif repo_name == 'Bitbucket' %}
|
|
<a href="{{ repo_url }}"> Edit on BitBucket</a>
|
|
{% else %}
|
|
<a href="{{ repo_url }}"> Edit in Repository</a>
|
|
{% endif %}
|
|
{% endif %}
|
|
|
|
<hr/>
|
|
|
|
<h2>Show the table of contents for the current page</h2>
|
|
<ul>
|
|
{% for toc_item in toc %}
|
|
<li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
|
|
{% for toc_item in toc_item.children %}
|
|
<li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
|
|
{% endfor %}
|
|
{% endfor %}
|
|
</ul>
|
|
|
|
<hr/>
|
|
|
|
{% block content %}
|
|
{{ content }}
|
|
{% endblock %}
|
|
|
|
<hr/>
|
|
<!--
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>.
|
|
-->
|
|
<!--
|
|
MkDocs version : {{ mkdocs_version }}
|
|
Docs Build Date UTC : {{ build_date_utc }}
|
|
-->
|
|
|
|
</body>
|
|
</html>
|