OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Package theme for submission to PyPI

Browse Source
This commit is contained in:
squidfunk 2016-02-04 15:03:20 +01:00
parent 4fdcb8de92
commit 06311058f6
77 changed files with 3299 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.gitignore vendored
View File

@ -20,3 +20,15 @@
# Mac OS X internals
.DS_Store
# Bower and NPM libraries
bower_components
node_modules
# Build files
build
MANIFEST
# Distribution files
dist
mkdocs_materializr.egg-info

3
CHANGELOG Normal file
View File

@ -0,0 +1,3 @@
materializr-0.1.0 (2016-xx-xx)
* Initial release

35
Gulpfile.js
View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013-2016 Martin Donath <martin.donath@squidfunk.com>
* 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
@ -105,7 +105,7 @@ gulp.task('assets:stylesheets', function() {
]))
.pipe(gulpif(args.sourcemaps, sourcemaps.write()))
.pipe(gulpif(args.production, mincss()))
.pipe(gulp.dest('dist/assets/stylesheets/'));
.pipe(gulp.dest('materializr/assets/stylesheets/'));
});
/*
@ -127,7 +127,7 @@ gulp.task('assets:javascripts', function() {
.pipe(concat('application.js'))
.pipe(gulpif(args.sourcemaps, sourcemaps.write()))
.pipe(gulpif(args.production, uglify()))
.pipe(gulp.dest('dist/assets/javascripts/'));
.pipe(gulp.dest('materializr/assets/javascripts/'));
});
/*
@ -138,8 +138,8 @@ gulp.task('assets:modernizr', [
'assets:javascripts'
], function() {
return gulp.src([
'dist/assets/stylesheets/application.css',
'dist/assets/javascripts/application.js'
'materializr/assets/stylesheets/application.css',
'materializr/assets/javascripts/application.js'
]).pipe(
modernizr({
options: [
@ -153,14 +153,14 @@ gulp.task('assets:modernizr', [
.pipe(addsrc.append('bower_components/respond/dest/respond.src.js'))
.pipe(concat('modernizr.js'))
.pipe(gulpif(args.production, uglify()))
.pipe(gulp.dest('dist/assets/javascripts'));
.pipe(gulp.dest('materializr/assets/javascripts'));
});
/*
* Copy static assets like images and webfonts.
*/
gulp.task('assets:static', function() {
return gulp.src('src/assets/{fonts,images}/*.{jpg,png,gif}')
return gulp.src('src/assets/{fonts,images}/*.{ico,jpg,png,gif}')
.pipe(gulpif(args.production,
minimage({
optimizationLevel: 5,
@ -168,18 +168,19 @@ gulp.task('assets:static', function() {
interlaced: true
})))
.pipe(addsrc.append('src/assets/{fonts,images}/*.{eot,svg,ttf,woff}'))
.pipe(gulp.dest('dist/assets/'));
.pipe(gulp.dest('materializr/assets/'));
});
/*
* Minify views.
*/
gulp.task('assets:views', args.production ? [
'assets:modernizr',
'assets:revisions:clean',
'assets:revisions'
] : [], function() {
return gulp.src([
'src/views/*.html'
'src/*.html'
]).pipe(
minhtml({
collapseBooleanAttributes: true,
@ -190,19 +191,19 @@ gulp.task('assets:views', args.production ? [
.pipe(compact())
.pipe(gulpif(args.production,
addsrc.append([
'dist/manifest.json',
'dist/**/*.css'
'materializr/manifest.json',
'materializr/**/*.css'
])))
.pipe(gulpif(args.production, collect()))
.pipe(ignore.exclude(/manifest\.json$/))
.pipe(gulp.dest('dist'));
.pipe(gulp.dest('materializr'));
});
/*
* Clean outdated revisions.
*/
gulp.task('assets:revisions:clean', function() {
return gulp.src(['dist/**/*.{css,js,png,jpg,gif}'])
return gulp.src(['materializr/**/*.{css,js,png,jpg,gif}'])
.pipe(ignore.include(/-[a-f0-9]{8}\.(css|js|png|jpg|gif)$/))
.pipe(vinyl(clean));
});
@ -216,12 +217,12 @@ gulp.task('assets:revisions', [
'assets:javascripts',
'assets:static'
], function() {
return gulp.src(['dist/**/*.{css,js,png,jpg,gif}'])
return gulp.src(['materializr/**/*.{css,js,png,jpg,gif}'])
.pipe(ignore.exclude(/-[a-f0-9]{8}\.(css|js|png|jpg|gif)$/))
.pipe(rev())
.pipe(gulp.dest('dist'))
.pipe(gulp.dest('materializr'))
.pipe(rev.manifest('manifest.json'))
.pipe(gulp.dest('dist'));
.pipe(gulp.dest('materializr'));
});
/*
@ -258,7 +259,7 @@ gulp.task('assets:watch', function() {
/* Minify views */
gulp.watch([
'src/views/*.html'
'src/*.html'
], ['assets:views']);
});

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
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.

3
MANIFEST.in Normal file
View File

@ -0,0 +1,3 @@
recursive-include materializr *.ico *.js *.css *.html *.eot *.svg *.ttf *.woff
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

6
README.txt Normal file
View File

@ -0,0 +1,6 @@
materializr
===========
A material design theme for MkDocs
TBD

3
bower.json
View File

@ -1,7 +1,7 @@
{
"name": "materializr",
"version": "0.1.0",
"description": "A material design template for mkdocs",
"description": "A material design theme for MkDocs",
"homepage": "https://github.com/squidfunk/materializr",
"authors": [
"squidfunk <martin.donath@squidfunk.com>"
@ -15,6 +15,7 @@
"bower_components",
"node_modules"
],
"private": true,
"dependencies": {
"classlist": "~2014.12.13",
"fastclick": "~1.0.6",

1
docs/index.md Normal file
View File

@ -0,0 +1 @@
A material design theme for MkDocs.

0
materializr/__init__.py Normal file
View File

BIN
materializr/assets/fonts/icon.eot Executable file
View File

Binary file not shown.

20
materializr/assets/fonts/icon.svg Executable file
View File

@ -0,0 +1,20 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
<svg xmlns="http://www.w3.org/2000/svg">
<metadata>Generated by IcoMoon</metadata>
<defs>
<font id="icon" horiz-adv-x="1024">
<font-face units-per-em="1024" ascent="960" descent="-64" />
<missing-glyph horiz-adv-x="1024" />
<glyph unicode="&#x20;" horiz-adv-x="512" d="" />
<glyph unicode="&#xe600;" glyph-name="search" d="M661.333 341.334h-33.92l-11.733 11.733c41.813 48.427 66.987 111.36 66.987 180.267 0 153.173-124.16 277.333-277.333 277.333s-277.333-124.16-277.333-277.333 124.16-277.333 277.333-277.333c68.907 0 131.84 25.173 180.267 66.773l11.733-11.733v-33.707l213.333-212.907 63.573 63.573-212.907 213.333zM405.333 341.334c-106.027 0-192 85.973-192 192s85.973 192 192 192 192-85.973 192-192-85.973-192-192-192z" />
<glyph unicode="&#xe601;" glyph-name="arrow-back" d="M853.333 469.334h-519.253l238.293 238.293-60.373 60.373-341.333-341.333 341.333-341.333 60.373 60.373-238.293 238.293h519.253v85.333z" />
<glyph unicode="&#xe602;" glyph-name="chevron-right" d="M426.667 682.667l-60.373-60.373 195.627-195.627-195.627-195.627 60.373-60.373 256 256z" />
<glyph unicode="&#xe603;" glyph-name="close" d="M810.667 664.96l-60.373 60.373-238.293-238.293-238.293 238.293-60.373-60.373 238.293-238.293-238.293-238.293 60.373-60.373 238.293 238.293 238.293-238.293 60.373 60.373-238.293 238.293z" />
<glyph unicode="&#xe604;" glyph-name="menu" d="M128 170.667h768v85.333h-768v-85.333zM128 384h768v85.333h-768v-85.333zM128 682.667v-85.333h768v85.333h-768z" />
<glyph unicode="&#xe605;" glyph-name="arrow-forward" d="M512 768l-60.373-60.373 238.293-238.293h-519.253v-85.333h519.253l-238.293-238.293 60.373-60.373 341.333 341.333z" />
<glyph unicode="&#xe606;" glyph-name="twitter" d="M1024 744.249c-37.676-16.708-78.164-28.002-120.66-33.080 43.372 26 76.686 67.17 92.372 116.23-40.596-24.078-85.556-41.56-133.41-50.98-38.32 40.83-92.922 66.34-153.346 66.34-116.022 0-210.088-94.058-210.088-210.078 0-16.466 1.858-32.5 5.44-47.878-174.6 8.764-329.402 92.4-433.018 219.506-18.084-31.028-28.446-67.116-28.446-105.618 0-72.888 37.088-137.192 93.46-174.866-34.438 1.092-66.832 10.542-95.154 26.278-0.020-0.876-0.020-1.756-0.020-2.642 0-101.788 72.418-186.696 168.522-206-17.626-4.8-36.188-7.372-55.348-7.372-13.538 0-26.698 1.32-39.528 3.772 26.736-83.46 104.32-144.206 196.252-145.896-71.9-56.35-162.486-89.934-260.916-89.934-16.958 0-33.68 0.994-50.116 2.94 92.972-59.61 203.402-94.394 322.042-94.394 386.422 0 597.736 320.124 597.736 597.744 0 9.108-0.206 18.168-0.61 27.18 41.056 29.62 76.672 66.62 104.836 108.748z" />
<glyph unicode="&#xe607;" glyph-name="github" d="M512.008 926.025c-282.738 0-512.008-229.218-512.008-511.998 0-226.214 146.704-418.132 350.136-485.836 25.586-4.738 34.992 11.11 34.992 24.632 0 12.204-0.48 52.542-0.696 95.324-142.448-30.976-172.504 60.41-172.504 60.41-23.282 59.176-56.848 74.916-56.848 74.916-46.452 31.778 3.51 31.124 3.51 31.124 51.4-3.61 78.476-52.766 78.476-52.766 45.672-78.27 119.776-55.64 149.004-42.558 4.588 33.086 17.852 55.68 32.506 68.464-113.73 12.942-233.276 56.85-233.276 253.032 0 55.898 20.004 101.574 52.76 137.428-5.316 12.9-22.854 64.972 4.952 135.5 0 0 43.006 13.752 140.84-52.49 40.836 11.348 84.636 17.036 128.154 17.234 43.502-0.198 87.336-5.886 128.256-17.234 97.734 66.244 140.656 52.49 140.656 52.49 27.872-70.528 10.35-122.6 5.036-135.5 32.82-35.856 52.694-81.532 52.694-137.428 0-196.654-119.778-239.95-233.79-252.624 18.364-15.89 34.724-47.046 34.724-94.812 0-68.508-0.596-123.644-0.596-140.508 0-13.628 9.222-29.594 35.172-24.566 203.322 67.776 349.842 259.626 349.842 485.768 0 282.78-229.234 511.998-511.992 511.998z" />
<glyph unicode="&#xe608;" glyph-name="download" d="M810.667 554.667h-170.667v256h-256v-256h-170.667l298.667-298.667 298.667 298.667zM213.333 170.667v-85.333h597.333v85.333h-597.333z" />
<glyph unicode="&#xe609;" glyph-name="star" d="M512 201.814l263.68-159.147-69.973 299.947 232.96 201.813-306.773 26.027-119.893 282.88-119.893-282.88-306.773-26.027 232.96-201.813-69.973-299.947z" />
</font></defs></svg>
Side by Side

After

Width:  |  Height:  |  Size: 4.0 KiB

BIN
materializr/assets/fonts/icon.ttf Executable file
View File

Binary file not shown.

BIN
materializr/assets/fonts/icon.woff Executable file
View File

Binary file not shown.

BIN
materializr/assets/images/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

1
materializr/assets/javascripts/application-3bd5fcbd.js Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/javascripts/application.js Normal file
View File

File diff suppressed because one or more lines are too long

2208
materializr/assets/javascripts/modernizr-e95367ea.js Normal file
View File

File diff suppressed because it is too large Load Diff

1
materializr/assets/javascripts/modernizr.js Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application-dd5b6433.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.blue-5e22f1b7.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.blue.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.green-ed0b1b20.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.green.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.grey-35d3a667.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.grey.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.pink-c98c1339.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.pink.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.purple-d52c9e49.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.purple.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.red-9049f37d.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.red.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.teal-51e9fed7.css Normal file
View File

File diff suppressed because one or more lines are too long

1
materializr/assets/stylesheets/application.teal.css Normal file
View File

File diff suppressed because one or more lines are too long

121
materializr/base.html Normal file
View File

@ -0,0 +1,121 @@
<!DOCTYPE html>
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
{% block htmltitle %}
{% if page_title %}
<title>{{ page_title }} - {{ site_name }}</title>
{% elif page_description %}
<title>{{ site_name }} - {{ page_description }}</title>
{% else %}
<title>{{ site_name }}</title>
{% endif %}
{% if page_description %}
<meta name="description" content="{{ page_description }}">
{% endif %}
{% if canonical_url %}
<link rel="canonical" href="{{ canonical_url }}">
{% endif %}
{% if site_author %}
<meta name="author" content="{{ site_author }}">
{% endif %}
{% endblock %}
<meta name="apple-mobile-web-app-title" content="{{ site_name }}">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="shortcut icon" type="image/x-icon" href="{{ icon | default('/assets/images/favicon.ico') }}">
<link rel="icon" type="image/x-icon" href="{{ icon | default('/assets/images/favicon.ico') }}">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:300,400,700">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu+Mono">
{% if config.extra.theme %}
{% set theme = config.extra.theme %}
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application.{{ theme }}.css">
{% else %}
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-dd5b6433.css">
{% endif %}
{% for path in extra_css %}
<link rel="stylesheet" href="{{ path }}">
{% endfor %}
{% block extrahead %}{% endblock %}
</head>
<body>
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
<input class="toggle" type="checkbox" id="toggle-drawer">
<input class="toggle" type="checkbox" id="toggle-search">
<label class="toggle-button overlay" for="toggle-drawer"></label>
<header class="header">
{% include "header.html" %}
</header>
<main class="main">
<div class="drawer">
{% include "drawer.html" %}
</div>
<article class="article">
<div class="wrapper">
{% if page_title %}
<h1>{{ page_title }}</h1>
{% else %}
<h1>{{ site_name }}</h1>
{% endif %}
<hr>
{{ content }}
<aside class="copyright" role="note">
{% if copyright %}
{{ copyright }} &ndash;
{% endif %}
Documentation built with
<a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
using the
<a href="https://github.com/squidfunk/materializr" target="_blank">
Materializr
</a>
theme.
</aside>
{% block footer %}
<footer class="footer">
{% include "footer.html" %}
</footer>
{% endblock %}
</div></article>
<div class="results" role="status" aria-live="polite">
<div class="scrollable">
<div class="wrapper">
<div class="meta"></div>
<div class="list"></div>
</div>
</div>
</div>
</main>
<script src="{{ base_url }}/assets/javascripts/modernizr-e95367ea.js"></script>
{% set repo_id = repo_url | replace('https://github.com/', '') %}
<script>
var base_url = '{{ base_url }}';
var repo_id = '{{ repo_id }}';
</script>
<script src="{{ base_url }}/assets/javascripts/application-3bd5fcbd.js"></script>
{% for path in extra_javascript %}
<script src="{{ path }}"></script>
{% endfor %}
{% 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('set', 'anonymizeIp', true);
ga('send', 'pageview');
</script>
{% endif %}
</body>
</html>

68
materializr/drawer.html Normal file
View File

@ -0,0 +1,68 @@
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
{% endif %}
<nav aria-label="navigation">
<a href="{{ repo_url }}" class="project">
<div class="banner">
{% if config.extra.logo %}
<div class="logo">
<img src="{{ config.extra.logo }}">
</div>
{% endif %}
<div class="name">
<strong>{{ site_name }} {{ config.extra.version }}</strong>
{% if repo_id %}
<br>
{{ repo_id }}
{% endif %}
</div>
</div>
</a>
<div class="scrollable">
<div class="wrapper">
{% if repo_name == 'GitHub' %}
<ul class="repo">
<li class="repo-download">
<a href="https://github.com/{{ repo_id }}/archive/master.zip" target="_blank" aria-label="Download {{ repo_id }} on GitHub">
<i class="icon icon-download"></i> Download
</a>
</li>
<li class="repo-stars">
<a href="https://github.com/{{ repo_id }}" target="_blank" aria-label="Star {{ repo_id }} on GitHub">
<i class="icon icon-star"></i> Star
<span class="count">&ndash;</span>
</a>
</li>
</ul>
<hr>
{% endif %}
<ul class="toc">
{% for nav_item in nav %}
{% include "toc.html" %}
{% endfor %}
{% if config.extra.author %}
<li>
<hr>
<span class="section">The author</span>
<ul>
{% if config.extra.author.twitter %}
<li>
<a href="https://twitter.com/{{ config.extra.author.twitter }}" title="@{{ config.extra.author.twitter }} on Twitter" target="_blank">
@{{ config.extra.author.twitter }} on Twitter
</a>
</li>
{% endif %}
{% if config.extra.author.github %}
<li>
<a href="https://github.com/{{ config.extra.author.github }}" title="@{{ config.extra.author.twitter }} on GitHub" target="_blank">
@{{ config.extra.author.github }} on GitHub
</a>
</li>
{% endif %}
</ul>
</li>
{% endif %}
</ul>
</div>
</div>
</nav>

38
materializr/footer.html Normal file
View File

@ -0,0 +1,38 @@
{% if include_next_prev %}
<nav class="pagination" aria-label="footer navigation">
<div class="previous">
{% if previous_page %}
<a href="{{ previous_page.url }}" title="{{ previous_page.title }}">
<span class="direction">Previous</span>
<div class="page">
<div class="button button-previous" role="button" aria-label="Previous">
<i class="icon icon-back"></i>
</div>
<div class="stretch">
<div class="title">
{{ previous_page.title }}
</div>
</div>
</div>
</a>
{% endif %}
</div>
<div class="next">
{% if next_page %}
<a href="{{ next_page.url }}" title="{{ next_page.title }}">
<span class="direction">Next</span>
<div class="page">
<div class="stretch">
<div class="title">
{{ next_page.title }}
</div>
</div>
<div class="button button-next" role="button" aria-label="Next">
<i class="icon icon-forward"></i>
</div>
</div>
</a>
{% endif %}
</div>
</nav>
{% endif %}

56
materializr/header.html Normal file
View File

@ -0,0 +1,56 @@
<nav aria-label="top navigation">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
<span></span>
</label>
</div>
<div class="stretch">
<div class="title">
{% if current_page %}
<span class="path">
{% for doc in current_page.ancestors %}
{% if doc.link %}
<a href="{{ doc.link | e }}">{{ doc.title }}</a>
<i class="icon icon-link"></i>
{% else %}
{{ doc.title }} <i class="icon icon-link"></i>
{% endif %}
{% endfor %}
</span>
{% endif %}
{% if page_title %}
{{ page_title }}
{% else %}
{{ site_name }}
{% endif %}
</div>
</div>
{% if config.extra.author and config.extra.author.twitter %}
<div class="button button-twitter" role="button" aria-label="Twitter">
<a href="https://twitter.com/{{ config.extra.author.twitter }}" title="@{{ config.extra.author.twitter }} on Twitter" target="_blank" class="toggle-button icon icon-twitter"></a>
</div>
{% endif %}
{% if config.extra.author and config.extra.author.github %}
<div class="button button-github" role="button" aria-label="GitHub">
<a href="https://github.com/{{ config.extra.author.github }}" title="@{{ config.extra.author.github }} on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
</div>
{% endif %}
<div class="button button-search" role="button" aria-label="Search">
<label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
</div>
</div>
<div class="bar search">
<div class="button button-close" role="button" aria-label="Close">
<label class="toggle-button icon icon-back" for="toggle-search"></label>
</div>
<div class="stretch">
<div class="field">
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
</div>
</div>
<div class="button button-reset" role="button" aria-label="Search">
<button class="toggle-button icon icon-close" id="reset-search"></button>
</div>
</div>
</nav>

12
materializr/manifest.json Normal file
View File

@ -0,0 +1,12 @@
{
"assets/javascripts/application.js": "assets/javascripts/application-3bd5fcbd.js",
"assets/javascripts/modernizr.js": "assets/javascripts/modernizr-e95367ea.js",
"assets/stylesheets/application.blue.css": "assets/stylesheets/application.blue-5e22f1b7.css",
"assets/stylesheets/application.css": "assets/stylesheets/application-dd5b6433.css",
"assets/stylesheets/application.green.css": "assets/stylesheets/application.green-ed0b1b20.css",
"assets/stylesheets/application.grey.css": "assets/stylesheets/application.grey-35d3a667.css",
"assets/stylesheets/application.pink.css": "assets/stylesheets/application.pink-c98c1339.css",
"assets/stylesheets/application.purple.css": "assets/stylesheets/application.purple-d52c9e49.css",
"assets/stylesheets/application.red.css": "assets/stylesheets/application.red-9049f37d.css",
"assets/stylesheets/application.teal.css": "assets/stylesheets/application.teal-51e9fed7.css"
}

28
materializr/toc.html Normal file
View File

@ -0,0 +1,28 @@
{% if nav_item.children %}
<li>
<hr>
<span class="section">{{ nav_item.title }}</span>
<ul>
{% for nav_item in nav_item.children %}
{% include 'toc.html' %}
{% endfor %}
</ul>
</li>
{% else %}
<li>
<a class="{% if nav_item.active %}current{% endif %}" title="{{ nav_item.title }}" href="{{ nav_item.url }}">
{{ nav_item.title }}
</a>
{% if nav_item == current_page %}
<ul>
{% for toc_item in toc %}
<li class="anchor">
<a class="{% if loop.first %}current{% endif %}" title="{{ toc_item.title }}" href="{{ toc_item.url }}">
{{ toc_item.title }}
</a>
</li>
{% endfor %}
</ul>
{% endif %}
</li>
{% endif %}

54
mkdocs.yml Executable file
View File

@ -0,0 +1,54 @@
# 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.
# Project information
site_name: materializr
site_description: A material design theme for MkDocs
site_author: Martin Donath
site_url: https://squidfunk.com/materializr
# Repository
repo_name: GitHub
repo_url: https://github.com/squidfunk/materializr
# Copyright
copyright: Copyright (c) 2016 Martin Donath
# Documentation and theme
docs_dir: docs
theme_dir: materializr
# Extra variables
extra:
color:
version: 0.1.0
logo:
author:
github: squidfunk
twitter: squidfunk
# Extensions
markdown_extensions:
- fenced_code
- codehilite(css_class=code)
# Page tree
pages:
- About: index.md

3
package.json
View File

@ -1,7 +1,7 @@
{
"name": "materializr",
"version": "0.1.0",
"description": "A material design template for mkdocs",
"description": "A material design theme for MkDocs",
"homepage": "https://github.com/squidfunk/materializr",
"authors": [
"squidfunk <martin.donath@squidfunk.com>"
@ -15,6 +15,7 @@
"type": "git",
"url": "https://github.com/squidfunk/materializr.git"
},
"private": true,
"devDependencies": {
"autoprefixer-core": "^5.1.11",
"css-mqpacker": "^3.1.0",

40
setup.py Normal file
View File

@ -0,0 +1,40 @@
# 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.
from setuptools import setup, find_packages
# Package description
setup(
name = 'mkdocs-materializr',
version = '0.1.0',
url = 'https://github.com/squidfunk/materializr',
license = 'MIT',
description = 'A material design theme for MkDocs',
author = 'Martin Donath',
author_email = 'martin.donath@squidfunk.com',
packages = find_packages(),
include_package_data = True,
entry_points = {
'mkdocs.themes': [
'materializr = materializr',
]
},
zip_safe = False
)

BIN
src/assets/fonts/icon.eot
View File

Binary file not shown.

121
src/assets/fonts/icon.json
View File

@ -15,15 +15,15 @@
},
"attrs": [],
"properties": {
"id": 1,
"id": 0,
"order": 7,
"prevSize": 24,
"code": 58880,
"name": "search"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 1
"setIdx": 1,
"setId": 4,
"iconIdx": 0
},
{
"icon": {
@ -39,15 +39,15 @@
},
"attrs": [],
"properties": {
"id": 2,
"id": 1,
"order": 4,
"prevSize": 24,
"code": 58881,
"name": "arrow-back"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 2
"setIdx": 1,
"setId": 4,
"iconIdx": 1
},
{
"icon": {
@ -63,15 +63,15 @@
},
"attrs": [],
"properties": {
"id": 3,
"id": 2,
"order": 9,
"prevSize": 24,
"code": 58882,
"name": "chevron-right"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 3
"setIdx": 1,
"setId": 4,
"iconIdx": 2
},
{
"icon": {
@ -87,15 +87,15 @@
},
"attrs": [],
"properties": {
"id": 4,
"id": 3,
"order": 8,
"prevSize": 24,
"code": 58883,
"name": "close"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 4
"setIdx": 1,
"setId": 4,
"iconIdx": 3
},
{
"icon": {
@ -111,15 +111,15 @@
},
"attrs": [],
"properties": {
"id": 5,
"id": 4,
"order": 10,
"prevSize": 24,
"code": 58884,
"name": "menu"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 5
"setIdx": 1,
"setId": 4,
"iconIdx": 4
},
{
"icon": {
@ -135,15 +135,15 @@
},
"attrs": [],
"properties": {
"id": 6,
"id": 5,
"order": 15,
"prevSize": 24,
"code": 58885,
"name": "arrow-forward"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 6
"setIdx": 1,
"setId": 4,
"iconIdx": 5
},
{
"icon": {
@ -163,16 +163,16 @@
},
"attrs": [],
"properties": {
"id": 7,
"id": 6,
"order": 9,
"prevSize": 24,
"code": 58886,
"ligatures": "twitter, brand11",
"name": "twitter"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 7
"setIdx": 1,
"setId": 4,
"iconIdx": 6
},
{
"icon": {
@ -188,15 +188,15 @@
},
"attrs": [],
"properties": {
"id": 8,
"id": 7,
"order": 10,
"prevSize": 24,
"code": 58888,
"name": "download"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 8
"setIdx": 1,
"setId": 4,
"iconIdx": 7
},
{
"icon": {
@ -212,66 +212,43 @@
},
"attrs": [],
"properties": {
"id": 9,
"id": 8,
"order": 9,
"prevSize": 24,
"code": 58889,
"name": "star"
},
"setIdx": 0,
"setId": 3,
"iconIdx": 9
"setIdx": 1,
"setId": 4,
"iconIdx": 8
},
{
"icon": {
"paths": [
"M598 726l84-172h-128v-256h256v256l-84 172h-128zM256 726l86-172h-128v-256h256v256l-86 172h-128z"
"M512.008 12.642c-282.738 0-512.008 229.218-512.008 511.998 0 226.214 146.704 418.132 350.136 485.836 25.586 4.738 34.992-11.11 34.992-24.632 0-12.204-0.48-52.542-0.696-95.324-142.448 30.976-172.504-60.41-172.504-60.41-23.282-59.176-56.848-74.916-56.848-74.916-46.452-31.778 3.51-31.124 3.51-31.124 51.4 3.61 78.476 52.766 78.476 52.766 45.672 78.27 119.776 55.64 149.004 42.558 4.588-33.086 17.852-55.68 32.506-68.464-113.73-12.942-233.276-56.85-233.276-253.032 0-55.898 20.004-101.574 52.76-137.428-5.316-12.9-22.854-64.972 4.952-135.5 0 0 43.006-13.752 140.84 52.49 40.836-11.348 84.636-17.036 128.154-17.234 43.502 0.198 87.336 5.886 128.256 17.234 97.734-66.244 140.656-52.49 140.656-52.49 27.872 70.528 10.35 122.6 5.036 135.5 32.82 35.856 52.694 81.532 52.694 137.428 0 196.654-119.778 239.95-233.79 252.624 18.364 15.89 34.724 47.046 34.724 94.812 0 68.508-0.596 123.644-0.596 140.508 0 13.628 9.222 29.594 35.172 24.566 203.322-67.776 349.842-259.626 349.842-485.768 0-282.78-229.234-511.998-511.992-511.998z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"format_quote"
"github",
"brand",
"octacat",
"social"
],
"defaultCode": 57924,
"grid": 24
},
"attrs": [],
"properties": {
"order": 10,
"ligatures": "format_quote",
"order": 27,
"prevSize": 24,
"name": "quote",
"id": 247,
"code": 58896
"ligatures": "github, brand40",
"name": "github",
"id": 433,
"code": 58887
},
"setIdx": 1,
"setId": 2,
"iconIdx": 247
},
{
"icon": {
"paths": [
"M365.714 694.857q0 22.857-7.143 46.857t-24.571 43.429-41.429 19.429-41.429-19.429-24.571-43.429-7.143-46.857 7.143-46.857 24.571-43.429 41.429-19.429 41.429 19.429 24.571 43.429 7.143 46.857zM731.429 694.857q0 22.857-7.143 46.857t-24.571 43.429-41.429 19.429-41.429-19.429-24.571-43.429-7.143-46.857 7.143-46.857 24.571-43.429 41.429-19.429 41.429 19.429 24.571 43.429 7.143 46.857zM822.857 694.857q0-68.571-39.429-116.571t-106.857-48q-23.429 0-111.429 12-40.571 6.286-89.714 6.286t-89.714-6.286q-86.857-12-111.429-12-67.429 0-106.857 48t-39.429 116.571q0 50.286 18.286 87.714t46.286 58.857 69.714 34.286 80 16.857 85.143 4h96q46.857 0 85.143-4t80-16.857 69.714-34.286 46.286-58.857 18.286-87.714zM950.857 594.286q0 118.286-34.857 189.143-21.714 44-60.286 76t-80.571 49.143-97.143 27.143-98 12.571-95.429 2.571q-44.571 0-81.143-1.714t-84.286-7.143-87.143-17.143-78.286-29.429-69.143-46.286-49.143-65.714q-35.429-70.286-35.429-189.143 0-135.429 77.714-226.286-15.429-46.857-15.429-97.143 0-66.286 29.143-124.571 61.714 0 108.571 22.571t108 70.571q84-20 176.571-20 84.571 0 160 18.286 60-46.857 106.857-69.143t108-22.286q29.143 58.286 29.143 124.571 0 49.714-15.429 96 77.714 91.429 77.714 227.429z"
],
"attrs": [],
"isMulticolor": false,
"width": 951,
"tags": [
"github-alt"
],
"grid": 0
},
"attrs": [],
"properties": {
"order": 13,
"id": 1,
"prevSize": 24,
"code": 58887,
"name": "github"
},
"setIdx": 2,
"setId": 1,
"iconIdx": 1
"setIdx": 5,
"setId": 0,
"iconIdx": 432
}
],
"height": 1024,

3
src/assets/fonts/icon.svg
View File

@ -14,8 +14,7 @@
<glyph unicode="&#xe604;" glyph-name="menu" d="M128 170.667h768v85.333h-768v-85.333zM128 384h768v85.333h-768v-85.333zM128 682.667v-85.333h768v85.333h-768z" />
<glyph unicode="&#xe605;" glyph-name="arrow-forward" d="M512 768l-60.373-60.373 238.293-238.293h-519.253v-85.333h519.253l-238.293-238.293 60.373-60.373 341.333 341.333z" />
<glyph unicode="&#xe606;" glyph-name="twitter" d="M1024 744.249c-37.676-16.708-78.164-28.002-120.66-33.080 43.372 26 76.686 67.17 92.372 116.23-40.596-24.078-85.556-41.56-133.41-50.98-38.32 40.83-92.922 66.34-153.346 66.34-116.022 0-210.088-94.058-210.088-210.078 0-16.466 1.858-32.5 5.44-47.878-174.6 8.764-329.402 92.4-433.018 219.506-18.084-31.028-28.446-67.116-28.446-105.618 0-72.888 37.088-137.192 93.46-174.866-34.438 1.092-66.832 10.542-95.154 26.278-0.020-0.876-0.020-1.756-0.020-2.642 0-101.788 72.418-186.696 168.522-206-17.626-4.8-36.188-7.372-55.348-7.372-13.538 0-26.698 1.32-39.528 3.772 26.736-83.46 104.32-144.206 196.252-145.896-71.9-56.35-162.486-89.934-260.916-89.934-16.958 0-33.68 0.994-50.116 2.94 92.972-59.61 203.402-94.394 322.042-94.394 386.422 0 597.736 320.124 597.736 597.744 0 9.108-0.206 18.168-0.61 27.18 41.056 29.62 76.672 66.62 104.836 108.748z" />
<glyph unicode="&#xe607;" glyph-name="github" horiz-adv-x="951" d="M365.714 243.81q0-22.857-7.143-46.857t-24.571-43.429-41.429-19.429-41.429 19.429-24.571 43.429-7.143 46.857 7.143 46.857 24.571 43.429 41.429 19.429 41.429-19.429 24.571-43.429 7.143-46.857zM731.429 243.81q0-22.857-7.143-46.857t-24.571-43.429-41.429-19.429-41.429 19.429-24.571 43.429-7.143 46.857 7.143 46.857 24.571 43.429 41.429 19.429 41.429-19.429 24.571-43.429 7.143-46.857zM822.857 243.81q0 68.571-39.429 116.571t-106.857 48q-23.429 0-111.429-12-40.571-6.286-89.714-6.286t-89.714 6.286q-86.857 12-111.429 12-67.429 0-106.857-48t-39.429-116.571q0-50.286 18.286-87.714t46.286-58.857 69.714-34.286 80-16.857 85.143-4h96q46.857 0 85.143 4t80 16.857 69.714 34.286 46.286 58.857 18.286 87.714zM950.857 344.381q0-118.286-34.857-189.143-21.714-44-60.286-76t-80.571-49.143-97.143-27.143-98-12.571-95.429-2.571q-44.571 0-81.143 1.714t-84.286 7.143-87.143 17.143-78.286 29.429-69.143 46.286-49.143 65.714q-35.429 70.286-35.429 189.143 0 135.429 77.714 226.286-15.429 46.857-15.429 97.143 0 66.286 29.143 124.571 61.714 0 108.571-22.571t108-70.571q84 20 176.571 20 84.571 0 160-18.286 60 46.857 106.857 69.143t108 22.286q29.143-58.286 29.143-124.571 0-49.714-15.429-96 77.714-91.429 77.714-227.429z" />
<glyph unicode="&#xe607;" glyph-name="github" d="M512.008 926.025c-282.738 0-512.008-229.218-512.008-511.998 0-226.214 146.704-418.132 350.136-485.836 25.586-4.738 34.992 11.11 34.992 24.632 0 12.204-0.48 52.542-0.696 95.324-142.448-30.976-172.504 60.41-172.504 60.41-23.282 59.176-56.848 74.916-56.848 74.916-46.452 31.778 3.51 31.124 3.51 31.124 51.4-3.61 78.476-52.766 78.476-52.766 45.672-78.27 119.776-55.64 149.004-42.558 4.588 33.086 17.852 55.68 32.506 68.464-113.73 12.942-233.276 56.85-233.276 253.032 0 55.898 20.004 101.574 52.76 137.428-5.316 12.9-22.854 64.972 4.952 135.5 0 0 43.006 13.752 140.84-52.49 40.836 11.348 84.636 17.036 128.154 17.234 43.502-0.198 87.336-5.886 128.256-17.234 97.734 66.244 140.656 52.49 140.656 52.49 27.872-70.528 10.35-122.6 5.036-135.5 32.82-35.856 52.694-81.532 52.694-137.428 0-196.654-119.778-239.95-233.79-252.624 18.364-15.89 34.724-47.046 34.724-94.812 0-68.508-0.596-123.644-0.596-140.508 0-13.628 9.222-29.594 35.172-24.566 203.322 67.776 349.842 259.626 349.842 485.768 0 282.78-229.234 511.998-511.992 511.998z" />
<glyph unicode="&#xe608;" glyph-name="download" d="M810.667 554.667h-170.667v256h-256v-256h-170.667l298.667-298.667 298.667 298.667zM213.333 170.667v-85.333h597.333v85.333h-597.333z" />
<glyph unicode="&#xe609;" glyph-name="star" d="M512 201.814l263.68-159.147-69.973 299.947 232.96 201.813-306.773 26.027-119.893 282.88-119.893-282.88-306.773-26.027 232.96-201.813-69.973-299.947z" />
<glyph unicode="&#xe610;" glyph-name="quote" d="M598 212.667l84 172h-128v256h256v-256l-84-172h-128zM256 212.667l86 172h-128v256h256v-256l-86-172h-128z" />
</font></defs></svg>
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.4 KiB

After

Width:  |  Height:  |  Size: 4.0 KiB

BIN
src/assets/fonts/icon.ttf
View File

Binary file not shown.

BIN
src/assets/fonts/icon.woff
View File

Binary file not shown.

BIN
src/assets/images/favicon-16x16.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 317 B

BIN
src/assets/images/favicon-32x32.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 501 B

BIN
src/assets/images/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

12
src/assets/javascripts/application.js
View File

@ -171,8 +171,10 @@ document.addEventListener('DOMContentLoaded', function() {
}
/* Register resize handler and fire once */
window.addEventListener('resize', check);
check();
if (!Modernizr.ios) {
window.addEventListener('resize', check);
check();
}
/* ----------------------------------------------------------------------------
* Initialize search index
@ -258,6 +260,10 @@ document.addEventListener('DOMContentLoaded', function() {
document.body.classList.remove('locked');
toggle.checked = false;
/* Don't catch anchors if the search doesn't cover the page */
if (matchMedia('only screen and (min-width: 960px)').matches)
return;
/* Prevent default to intercept scroll-to behaviour and
stop propagation, as this interferes with the link-lock in
the web application context, which opens all internal links
@ -347,7 +353,7 @@ document.addEventListener('DOMContentLoaded', function() {
setTimeout(function() {
/* This additional check is necessary to handle fast subsequent clicks
on the toggle and the timeout to lock the body must be canceled */
on the toggle and the timeout to lock the body must be cancelled */
if (this.checked) {
if (lock)
list.add('locked');

41
src/assets/stylesheets/_highlight.scss
View File

@ -25,51 +25,44 @@
* ------------------------------------------------------------------------- */
/*
* Comments
* Background
*/
.c,
.cm {
color: #666;
pre {
background: darken($white, 3.5%);
color: $black;
}
/*
* Operators and comments
*/
.o, .c, .c1, .cm {
color: $black-light;
}
/*
* Keywords
*/
.k {
color: $pink-500;
color: #A71D5D;
}
/*
* Types
* Types and functions
*/
.kt, .kd {
color: $light-blue-300;
.kt, .kd, .n.f {
color: #0086B3;
}
/*
* Strings
*/
.s {
color: $lime-300;
}
/*
* Operators and names
*/
.o, .na {
color: $white-light;
color: #183691;
}
/*
* Numbers
*/
.mi {
color: $deep-purple-300;
}
/*
* Functions
*/
.n.f {
color: saturate(mix($green-300, $teal-300, 50%), 50%);
color: #9575CD;
}

4
src/assets/stylesheets/_palette.scss
View File

@ -27,8 +27,8 @@
/*
* Primary and accent color
*/
$primary: $indigo-500;
$accent: $teal-500;
$primary: $indigo-500 !default;
$accent: $teal-500 !default;
/*
* Black opacities

2
src/assets/stylesheets/_print.scss
View File

@ -49,7 +49,7 @@
}
/*
* Border-radius makes this table entirely black on paper
* Border-radius makes this table entirely black on paper, so scrap it
*/
table {
border-radius: none;

15
src/assets/stylesheets/_shame.scss
View File

@ -21,18 +21,5 @@
*/
/* ----------------------------------------------------------------------------
* Here should be nothing
* Nothing to see here, move along
* ------------------------------------------------------------------------- */
/* [tablet portait+]: Slightly larger project name */
@include break-from-device(tablet landscape) {
.project .name {
color: $black;
}
}
@include break-from-device(tablet landscape) {
.button-menu {
display: none;
}
}

56
src/assets/stylesheets/application.blue.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $light-blue-500;
$accent: $red-a400;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

56
src/assets/stylesheets/application.green.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $light-green-700;
$accent: $cyan-a700;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

56
src/assets/stylesheets/application.grey.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $blue-grey-700;
$accent: $red-a400;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

56
src/assets/stylesheets/application.pink.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $pink-500;
$accent: $indigo-a400;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

56
src/assets/stylesheets/application.purple.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $deep-purple-500;
$accent: $light-green-a700;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

56
src/assets/stylesheets/application.red.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $red-500;
$accent: $light-blue-a400;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

1
src/assets/stylesheets/application.scss
View File

@ -46,5 +46,4 @@
@import "modules/search";
@import "print";
@import "shame";

56
src/assets/stylesheets/application.teal.scss Normal file
View File

@ -0,0 +1,56 @@
/*
* 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.
*/
/* ----------------------------------------------------------------------------
* Dependencies
* ------------------------------------------------------------------------- */
@import "bourbon";
@import "quantum-colors";
@import "quantum-shadows";
/* ----------------------------------------------------------------------------
* Palette
* ------------------------------------------------------------------------- */
$primary: $teal-500;
$accent: $pink-a400;
/* ----------------------------------------------------------------------------
* Application
* ------------------------------------------------------------------------- */
@import "reset";
@import "palette";
@import "highlight";
@import "fonts/icon";
@import "mixins/break";
@import "modules/base";
@import "modules/drawer";
@import "modules/article";
@import "modules/search";
@import "print";
@import "shame";

7
src/assets/stylesheets/fonts/_icon.scss
View File

@ -128,10 +128,3 @@
.icon-star:before {
content: "\e609";
}
/*
* Quote icon
*/
.icon-quote:before {
content: "\e610";
}

10
src/assets/stylesheets/modules/article/_appearance.scss
View File

@ -28,8 +28,6 @@
* Article
*/
.article {
color: $black;
/*
* Differing top and bottom rubberband backgrounds in iOS web application
@ -52,14 +50,6 @@
color: $primary;
}
/*
* Code listing in negative colors
*/
pre {
background: $black;
color: $white;
}
/*
* Color links
*/

1
src/assets/stylesheets/modules/base/_appearance.scss
View File

@ -28,6 +28,7 @@
* Device specific background hacks related to rubberband
*/
body {
color: $black;
/* Hack [Chrome, Opera]: Set background color in Chrome and Opera */
@supports (-webkit-appearance: none) {

20
src/assets/stylesheets/modules/base/_layout.scss
View File

@ -292,6 +292,17 @@ hr {
}
}
/*
* Hide menu button
*/
.button-menu {
/* [tablet landscape+]: Hide button */
@include break-from-device(tablet landscape) {
display: none;
}
}
/*
* Stretch content to remaining space
*/
@ -306,10 +317,15 @@ hr {
.header & {
padding: 0 20px;
/* [tablet portait+]: Increase vertical spacing */
@include break-from-device(tablet portrait) {
/* [tablet portait]: Increase vertical spacing */
@include break-at-device(tablet portrait) {
padding: 0 24px;
}
/* [tablet portait+]: Account for missing menu icon */
@include break-from-device(tablet portrait) {
padding: 0 (24px - 8px) 0 16px;
}
}
/*

7
src/assets/stylesheets/modules/drawer/_animation.scss
View File

@ -58,6 +58,13 @@
}
}
/*
* No color transition for project link
*/
.project {
transition: none;
}
/*
* Project logo image
*/

2
src/assets/stylesheets/modules/drawer/_appearance.scss
View File

@ -77,13 +77,13 @@
* Project information
*/
.project {
color: $white;
/* [tablet landscape-]: Add drop shadow */
@include break-to-device(tablet landscape) {
@include drop-shadow(1);
background: $primary;
color: $white;
}
/*

24
src/assets/stylesheets/modules/drawer/_layout.scss
View File

@ -90,7 +90,7 @@
/* [tablet landscape+]: Revert fixed positioning */
@include break-from-device(tablet landscape) {
position: initial;
position: static;
}
/*
@ -121,6 +121,9 @@
@include break-from-device(screen) {
width: 48px;
}
/* Hack [IE]: Left-align horizontal rule */
margin-right: auto;
}
/*
@ -169,6 +172,7 @@
.banner {
display: table;
width: 100%;
height: 104px;
padding: 20px;
}
@ -178,15 +182,15 @@
.logo {
display: table-cell;
width: 64px;
height: 64px;
padding-right: 12px;
/*
* Project logo image
*/
img {
display: block;
width: 100%;
height: auto;
width: 64px;
height: 64px;
}
}
@ -195,9 +199,9 @@
*/
.name {
display: table-cell;
font-size: 16px;
padding-left: 4px;
font-size: 14px;
line-height: 1.25em;
padding-left: 16px;
vertical-align: middle;
/* [tablet portait+]: Slightly larger project name */
@ -205,13 +209,19 @@
margin: 26px 0 0 5px;
}
}
/*
* Shrink font, if a logo is given.
*/
.logo + .name {
font-size: 12px;
}
}
/*
* Repository
*/
.repo {
padding: 0 16px;
margin: 24px 0;
text-align: center;

23
src/assets/stylesheets/modules/search/_layout.scss
View File

@ -45,6 +45,11 @@
font-size: 20px;
padding: 12px 0;
}
/* Hack [IE]: Hide redundant clear button */
&::-ms-clear {
display: none;
}
}
}
@ -56,12 +61,14 @@
top: 0;
left: 0;
width: 0;
height: 100%;
z-index: 2;
overflow: scroll;
overflow-y: scroll;
-webkit-overflow-scrolling: touch;
/* [tablet landscape+]: Limit results to five entries */
@include break-from-device(tablet landscape) {
height: auto;
top: 64px;
}
@ -78,8 +85,7 @@
/* [tablet landscape+]: Limit results to five entries */
@include break-from-device(tablet landscape) {
position: initial;
bottom: auto;
position: static;
max-height: 413px;
}
@ -184,9 +190,9 @@
}
/*
* Prevent flickering on scroll in IE9
* Switch visibility, if browser doesn't support 3D transforms
*/
.ie9 {
.no-csstransforms3d {
/*
* Hide search results
@ -208,12 +214,5 @@
display: block;
overflow: auto;
}
/*
* Article and footer may shine through, so make them invisible
*/
.article, .footer {
visibility: hidden;
}
}
}

24
src/views/base.html → src/base.html
View File

@ -17,6 +17,8 @@
<!-- 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 %}
@ -44,10 +46,10 @@
content="black-translucent" />
<!-- Favicon -->
<link rel="icon" type="image/png"
href="{{ base_url }}/assets/images/favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png"
href="{{ base_url }}/assets/images/favicon-16x16.png" sizes="16x16" />
<link rel="shortcut icon" type="image/x-icon"
href="{{ icon | default('/assets/images/favicon.ico') }}" />
<link rel="icon" type="image/x-icon"
href="{{ icon | default('/assets/images/favicon.ico') }}" />
<!-- Webfonts -->
<link rel="stylesheet" type="text/css"
@ -56,8 +58,14 @@
href="https://fonts.googleapis.com/css?family=Ubuntu+Mono" />
<!-- Theme-related and custom stylesheets -->
<link rel="stylesheet" type="text/css"
href="{{ base_url }}/assets/stylesheets/application.css" />
{% if config.extra.color %}
{% set color = config.extra.color %}
<link rel="stylesheet" type="text/css"
href="{{ base_url }}/assets/stylesheets/application.{{ color }}.css" />
{% else %}
<link rel="stylesheet" type="text/css"
href="{{ base_url }}/assets/stylesheets/application.css" />
{% endif %}
{% for path in extra_css %}
<link rel="stylesheet" type="text/css" href="{{ path }}" />
{% endfor %}
@ -115,9 +123,9 @@
Documentation built with
<a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
using the
<a href="https://github.com/squidfunk/materialize"
<a href="https://github.com/squidfunk/materializr"
target="_blank">
Materialize
Materializr
</a>
theme.
</aside>

27
src/views/drawer.html → src/drawer.html
View File

@ -1,14 +1,32 @@
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
{% endif %}
<!-- Navigation -->
<nav aria-label="navigation">
<!-- Project information -->
<a href="/" class="project">
<a href="{{ repo_url }}" class="project">
<!-- Name and logo -->
<div class="banner">
<div class="logo"></div>
<!-- Version -->
{% if config.extra.logo %}
<div class="logo">
<img src="{{ config.extra.logo }}" />
</div>
{% endif %}
<!-- Project name and verison -->
<div class="name">
{{ site_name }}
<strong>{{ site_name }} {{ config.extra.version }}</strong>
<!-- Project repository name -->
{% if repo_id %}
<br />
{{ repo_id }}
{% endif %}
</div>
</div>
</a>
@ -19,7 +37,6 @@
<!-- Repository -->
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
<ul class="repo">
<li class="repo-download">
<a href="https://github.com/{{ repo_id }}/archive/master.zip"
@ -45,7 +62,7 @@
{% endfor %}
<!-- Author-related links -->
{% if config.extra.author.twitter or config.extra.author.github %}
{% if config.extra.author %}
<li>
<hr />
<span class="section">The author</span>

0
src/views/footer.html → src/footer.html
View File

4
src/views/header.html → src/header.html
View File

@ -35,7 +35,7 @@
</div>
<!-- Twitter -->
{% if config.extra.author.twitter %}
{% if config.extra.author and config.extra.author.twitter %}
<div class="button button-twitter" role="button" aria-label="Twitter">
<a href="https://twitter.com/{{ config.extra.author.twitter }}"
title="@{{ config.extra.author.twitter }} on Twitter" target="_blank"
@ -44,7 +44,7 @@
{% endif %}
<!-- GitHub -->
{% if config.extra.author.github %}
{% if config.extra.author and config.extra.author.github %}
<div class="button button-github" role="button" aria-label="GitHub">
<a href="https://github.com/{{ config.extra.author.github }}"
title="@{{ config.extra.author.github }} on GitHub" target="_blank"

0
src/views/toc.html → src/toc.html
View File