-
Notifications
You must be signed in to change notification settings - Fork 41
Expand file tree
/
Copy pathbase.html
More file actions
197 lines (159 loc) · 5.61 KB
/
base.html
File metadata and controls
197 lines (159 loc) · 5.61 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<!--
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>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!--
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 %}{{ config.site_name }}</title>
<!--
Just add a favicon.ico image to the docs.
-->
<link rel="shortcut icon" href="{{ "img/favicon.ico"|url }}">
<!--
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://unpkg.com/purecss@1.0.0/build/pure-min.css">
<link rel="stylesheet" href="{{ "css/theme.css"|url }}">
<!--
extra_css 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 config.extra_css %}
<link href="{{ path|url }}" rel="stylesheet">
{% endfor %}
<script
src="https://code.jquery.com/jquery-3.3.1.slim.min.js"
integrity="sha256-3edrmyuQ0w65f8gfBsqowzjJe2iM6n0nKciPUp8y+7E="
crossorigin="anonymous"></script>
<!--
To include static assets from our theme, just make the path
relative to the root of the documentation with `|url`.
-->
<script src="{{ "js/theme.js"|url }}"></script>
{% block extrahead %}
{% endblock %}
<!--
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 script in config.extra_javascript %}
{{ script | script_tag }}
{% endfor %}
<!--
Include Google Analytics tracking code.
http://www.mkdocs.org/user-guide/configuration/#google_analytics
-->
{% if config.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','https://www.google-analytics.com/analytics.js','ga');
ga('create', '{{ config.google_analytics[0] }}', '{{ config.google_analytics[1] }}');
ga('send', 'pageview');
</script>
{% endif %}
</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="{{ "search.html"|url }}" 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 page.next_page or page.previous_page %}
<div>
{% if page.previous_page %}
<a href="{{ page.previous_page.url|url }}" title="{{ page.previous_page.title }}">← Previous Page</a>
{% else %}
← Previous Page
{% endif %}
-
{% if page.next_page %}
<a href="{{ page.next_page.url|url }}" title="{{ page.next_page.title }}"/>Next Page →</a>
{% else %}
Next Page →
{% endif %}
</div>
{% endif %}
<hr/>
<h2>Link to the source</h2>
<!--
Support repo URL
-->
{% if page and page.edit_url %}
<a href="{{ page.edit_url }}">Edit on {{ config.repo_name }}</a>
{% elif config.repo_url %}
<a href="{{ config.repo_url }}">{{ config.repo_name }}</a>
{% endif %}
<hr/>
<h2>Show the table of contents for the current page</h2>
<ul>
{% for toc_item in page.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 %}
{{ page.content }}
{% endblock %}
<hr/>
Built with <a href="https://www.mkdocs.org">MkDocs</a>.
<!--
MkDocs version : {{ mkdocs_version }}
Docs Build Date UTC : {{ build_date_utc }}
-->
</body>
</html>