Compare commits

...
15 Commits
53 changed files with 852 additions and 580 deletions
+39
View File
@@ -0,0 +1,39 @@
# Copyright (c) 2013-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.
language: node_js
# Node.js versions
node_js:
- '4.1'
- '0.11'
# Install dependencies
before_script:
# Install bower
- npm install -g bower
# Install project dependencies
- npm install
- bower install
# Perform build and tests
script: gulp build --production
+18
View File
@@ -1,3 +1,21 @@
mkdocs-material-0.1.2 (2016-02-16)
* Fixed styles for deep navigational hierarchies
* Fixed webfont delivery problem when hosted in subdirectories
* Fixed print styles in mobile/tablet configuration
* Added option to configure fonts in mkdocs.yml with fallbacks
* Changed styles for admonition notes and warnings
* Set download link to latest version if available
* Set up tracking of outgoing links and actions for Google Analytics
mkdocs-material-0.1.1 (2016-02-11)
* Fixed #1: GitHub stars don't work if the repo_url ends with a '/'
* Updated npm and bower dependencies to most recent versions
* Changed footer/copyright link to Material theme to GitHub pages
* Made MkDocs building/serving in build process optional
* Set up continuous integration with travis-ci.org
mkdocs-material-0.1.0 (2016-02-09)
* Initial release
+20 -18
View File
@@ -27,7 +27,7 @@
var gulp = require('gulp');
var addsrc = require('gulp-add-src');
var args = require('yargs').argv;
var autoprefix = require('autoprefixer-core');
var autoprefix = require('autoprefixer');
var child = require('child_process');
var clean = require('del');
var collect = require('gulp-rev-collector');
@@ -35,7 +35,7 @@ var compact = require('gulp-remove-empty-lines');
var concat = require('gulp-concat');
var ignore = require('gulp-ignore');
var gulpif = require('gulp-if');
var mincss = require('gulp-minify-css');
var mincss = require('gulp-cssnano');
var minhtml = require('gulp-htmlmin');
var minimage = require('gulp-image-optimization');
var modernizr = require('gulp-modernizr');
@@ -54,7 +54,7 @@ var vinyl = require('vinyl-paths');
* Locals
* ------------------------------------------------------------------------- */
/* Application server */
/* MkDocs server */
var server = null;
/* ----------------------------------------------------------------------------
@@ -204,7 +204,7 @@ gulp.task('assets:views', args.production ? [
*/
gulp.task('assets:revisions:clean', function() {
return gulp.src(['material/**/*.{ico,css,js,png,jpg,gif}'])
.pipe(ignore.include(/-[a-f0-9]{8}\.(ico|css|js|png|jpg|gif)$/))
.pipe(ignore.include(/-[a-f0-9]{8,}\.(ico|css|js|png|jpg|gif)$/))
.pipe(vinyl(clean));
});
@@ -218,7 +218,7 @@ gulp.task('assets:revisions', [
'assets:static'
], function() {
return gulp.src(['material/**/*.{ico,css,js,png,jpg,gif}'])
.pipe(ignore.exclude(/-[a-f0-9]{8}\.(css|js|png|jpg|gif)$/))
.pipe(ignore.exclude(/-[a-f0-9]{8,}\.(css|js|png|jpg|gif)$/))
.pipe(rev())
.pipe(gulp.dest('material'))
.pipe(rev.manifest('manifest.json'))
@@ -268,22 +268,22 @@ gulp.task('assets:watch', function() {
* ------------------------------------------------------------------------- */
/*
* Build application server.
* Build documentation.
*/
gulp.task('server:build', [
gulp.task('mkdocs:build', [
'assets:build'
], function() {
return child.spawnSync('mkdocs', ['build']);
});
/*
* Restart application server.
* Restart MkDocs server.
*/
gulp.task('server:spawn', function() {
gulp.task('mkdocs:serve', function() {
if (server)
server.kill();
/* Spawn application server */
/* Spawn MkDocs server */
server = child.spawn('mkdocs', ['serve', '-a', '0.0.0.0:8000']);
/* Pretty print server log output */
@@ -305,23 +305,25 @@ gulp.task('server:spawn', function() {
* ------------------------------------------------------------------------- */
/*
* Build assets and application server.
* Build assets and documentation.
*/
gulp.task('build', [
'assets:build',
'server:build'
]);
'assets:build'
].concat(args.mkdocs
? 'mkdocs:build'
: []));
/*
* Start asset and server watchdogs.
* Start asset and MkDocs watchdogs.
*/
gulp.task('watch', [
'assets:build',
], function() {
return gulp.start([
'assets:watch',
'server:spawn'
]);
'assets:watch'
].concat(args.mkdocs
? 'mkdocs:serve'
: []));
});
/*
+33 -10
View File
@@ -1,13 +1,14 @@
# Material
[![Travis CI][travis-image]][travis-link]
[![PyPI Downloads][pypi-dl-image]][pypi-dl-link]
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Release Status][release-image]][release-link]
[![License][license-image]][license-link]
A material design theme for MkDocs.
A material design theme for [MkDocs](http://www.mkdocs.org).
![iOS](docs/images/screen.png)
[![iOS](docs/images/screen.png)](http://squidfunk.github.io/mkdocs-material/)
## Quick start
Install with `pip`:
@@ -21,13 +22,35 @@ Add the following line to your `mkdocs.yml`:
theme: 'material'
```
For detailed installation instructions and a demo, visit [squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)
For detailed installation instructions and a demo, visit
http://squidfunk.github.io/mkdocs-material/
## License
**MIT License**
Copyright (c) 2016 Martin Donath
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.
[travis-image]: https://travis-ci.org/squidfunk/mkdocs-material.svg
[travis-link]: https://travis-ci.org/squidfunk/mkdocs-material
[pypi-dl-image]: https://img.shields.io/pypi/dm/mkdocs-material.png
[pypi-dl-link]: https://pypi.python.org/pypi/mkdocs-material
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-material.png
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
[release-image]: https://img.shields.io/github/release/squidfunk/mkdocs-material.svg
[release-link]: https://github.com/squidfunk/mkdocs-material/releases/latest
[license-image]: https://img.shields.io/github/license/squidfunk/mkdocs-material.svg
[license-link]: https://github.com/squidfunk/mkdocs-material/blob/master/LICENSE
[pypi-v-link]: https://pypi.python.org/pypi/mkdocs-material
+10 -10
View File
@@ -1,6 +1,6 @@
{
"name": "Material",
"version": "0.1.0",
"name": "mkdocs-material",
"version": "0.1.2",
"description": "A material design theme for MkDocs",
"homepage": "http://squidfunk.github.io/mkdocs-material/",
"authors": [
@@ -17,15 +17,15 @@
],
"private": true,
"dependencies": {
"classlist": "~2014.12.13",
"fastclick": "~1.0.6",
"lunr.js": "~0.5.10",
"pegasus": "~0.3.1",
"respond": "~1.4.2"
"classlist": "^2014.12.13",
"fastclick": "^1.0.6",
"lunr.js": "^0.6.0",
"pegasus": "^0.3.2",
"respond": "^1.4.2"
},
"devDependencies": {
"bourbon": "~4.2.2",
"quantum-colors": "~1.0.1",
"quantum-shadows": "~1.0.0"
"bourbon": "^4.2.6",
"quantum-colors": "^1.0.1",
"quantum-shadows": "^1.0.0"
}
}
+10 -4
View File
@@ -116,7 +116,8 @@ extra:
If you want to change the fonts or colors - you are lucky. The Material theme
is built with a sophisticated asset pipeline. See
[this article](/customization) for more information on advanced customization.
[this article](customization.md) for more information on advanced
customization.
## Extensions
@@ -174,8 +175,13 @@ This will print the following:
!!! note
Nothing to see here, move along.
The Material template adds a light color for the `note` class and a red color
for the `warning` class. More colors can be freely defined.
The Material template adds a neutral color for the `note` class and a red color
for the `warning` class.
!!! warning
You shall not pass.
More colors can be freely defined.
## Full example
@@ -186,7 +192,7 @@ Below is a full example configuration for a mkdocs.yml:
site_name: 'My Project'
site_description: 'A short description of my project'
site_author: 'John Doe'
site_url: 'https://github.com/my-github-handle/my-project'
site_url: 'https://my-github-handle.github.io/my-project'
# Repository
repo_name: 'GitHub'
Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.7 KiB

After

Width:  |  Height:  |  Size: 24 KiB

+4 -4
View File
@@ -7,7 +7,7 @@ Google's [material design][] guidelines. MkDocs is an excellent static site
documentation generator that is meant for building good looking project
documentation.
![Material Screenshot](/images/screen.png)
![Material Screenshot](images/screen.png)
This theme is **optimized for all sorts of devices** and is built from scratch
without any bloated Javascript or CSS Frameworks with **only 24kb of JS and
@@ -24,8 +24,8 @@ browsers.
- Well-tested and **optimized CSS and Javascript**, including a cross-browser
fixed/sticky header, a drawer that even works without Javascript using
the `checkbox:checked` hack with fallbacks, **responsive tables** that scroll
when the screen is too small and **well-defined print styles**.
the `:checked` hack with fallbacks, **responsive tables** that scroll when
the screen is too small and **well-defined print styles**.
- Extra configuration options like **project logo**, links to the authors
**GitHub and Twitter accounts** and display of the **amount of stars** the
@@ -38,7 +38,7 @@ browsers.
- **Web application capability** on iOS - when the page is saved to the
homescreen, it behaves and looks like a native application.
See the [getting started guide](/getting-started) for instructions how to get
See the [getting started guide](getting-started.md) for instructions how to get
it up and running.
[material design]: https://www.google.com/design/spec/material-design
+1
View File
@@ -1,5 +1,6 @@
# License
**MIT License**
Copyright (c) 2016 Martin Donath
Permission is hereby granted, free of charge, to any person obtaining a copy
Binary file not shown.
+2
View File
@@ -17,4 +17,6 @@
<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="warning" d="M554 340.667v172h-84v-172h84zM554 170.667v86h-84v-86h84zM42 42.667l470 810 470-810h-940z" />
<glyph unicode="&#xe611;" glyph-name="hint" d="M614 682.667h240v-426h-300l-16 84h-240v-298h-84v726h384z" />
</font></defs></svg>

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+59 -9
View File
@@ -34,18 +34,58 @@
{% if config.extra.logo %}
<link rel="apple-touch-icon" href="{{ base_url }}/{{ config.extra.logo }}">
{% endif %}
{% set icon = icon | default('assets/images/favicon-e565ddfa.ico') %}
{% set icon = icon | default('assets/images/favicon-e565ddfa3b.ico') %}
<link rel="shortcut icon" type="image/x-icon" href="{{ base_url }}/{{ icon }}">
<link rel="icon" type="image/x-icon" href="{{ base_url }}/{{ icon }}">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:400,700">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu+Mono">
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-334f02ec.css">
<style>
@font-face {
font-family: 'Icon';
src: url('{{ base_url }}/assets/fonts/icon.eot?52m981');
src: url('{{ base_url }}/assets/fonts/icon.eot?#iefix52m981')
format('embedded-opentype'),
url('{{ base_url }}/assets/fonts/icon.woff?52m981')
format('woff'),
url('{{ base_url }}/assets/fonts/icon.ttf?52m981')
format('truetype'),
url('{{ base_url }}/assets/fonts/icon.svg?52m981#icon')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-f5ffeca01e.css">
{% if config.extra.font != 'none' %}
{% set text = 'Ubuntu' %}
{% if config.extra.font and config.extra.font.text %}
{% set text = config.extra.font.text %}
{% endif %}
{% set code = 'Ubuntu Mono' %}
{% if config.extra.font and config.extra.font.code %}
{% set code = config.extra.font.code %}
{% endif %}
{% set font = text + ':400,700|' + code | replace('+', ' ') %}
<link rel="stylesheet" href="//fonts.googleapis.com/css?family={{ font }}">
<style>
body, input {
font-family: '{{ text }}', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: '{{ code }}', 'Courier New', 'Courier', monospace;
}
</style>
{% endif %}
{% for path in extra_css %}
<link rel="stylesheet" href="{{ path }}">
{% endfor %}
{% block extrahead %}{% endblock %}
</head>
<body>
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
{% if repo_id[-1:] == '/' %}
{% set repo_id = repo_id[:-1] %}
{% endif %}
{% endif %}
<div class="backdrop">
<div class="backdrop-paper"></div>
</div>
@@ -77,7 +117,7 @@
Documentation built with
<a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
using the
<a href="https://github.com/squidfunk/mkdocs-material" target="_blank">
<a href="http://squidfunk.github.io/mkdocs-material/" target="_blank">
Material
</a>
theme.
@@ -97,13 +137,12 @@
</div>
</div>
</main>
<script src="{{ base_url }}/assets/javascripts/modernizr-79394028.js"></script>
{% set repo_id = repo_url | replace('https://github.com/', '') %}
<script src="{{ base_url }}/assets/javascripts/modernizr-4ab42b99fd.js"></script>
<script>
var base_url = '{{ base_url }}';
var repo_id = '{{ repo_id }}';
</script>
<script src="{{ base_url }}/assets/javascripts/application-d84ecdee.js"></script>
<script src="{{ base_url }}/assets/javascripts/application-c6d2e828bd.js"></script>
{% for path in extra_javascript %}
<script src="{{ path }}"></script>
{% endfor %}
@@ -115,10 +154,21 @@
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');
'script', '//www.google-analytics.com/analytics.js', 'ga');
/* General initialization */
ga('create', '{{ google_analytics[0] }}', '{{ google_analytics[1] }}');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
/* Track outbound links */
var buttons = document.querySelectorAll('a');
Array.prototype.map.call(buttons, function(item) {
if (item.host != window.location.host) {
item.addEventListener('click', function() {
var action = item.getAttribute('data-action') || 'follow';
ga('send', 'event', 'outbound', action, item.href);
});
}
});
</script>
{% endif %}
</body>
+31 -31
View File
@@ -1,7 +1,4 @@
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
{% endif %}
<nav aria-label="navigation">
<nav aria-label="Navigation">
<a href="{{ repo_url }}" class="project">
<div class="banner">
{% if config.extra.logo %}
@@ -23,12 +20,13 @@
{% 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">
{% set version = config.extra.version | default('master') %}
<a href="{{ repo_url }}/archive/{{ version }}.zip" target="_blank" title="Download {{ site_name }} from GitHub" data-action="download">
<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">
<a href="{{ repo_url }}" target="_blank" title="Star {{ site_name }} on GitHub" data-action="star">
<i class="icon icon-star"></i> Star
<span class="count">&ndash;</span>
</a>
@@ -36,33 +34,35 @@
</ul>
<hr>
{% endif %}
<ul class="toc">
{% for nav_item in nav %}
{% include "nav.html" %}
{% endfor %}
<div class="toc">
<ul>
{% for nav_item in nav %}
{% include "nav.html" %}
{% endfor %}
</ul>
{% 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>
<hr>
<span class="section">The author</span>
<ul>
{% if config.extra.author.twitter %}
{% set author = config.extra.author.twitter %}
<li>
<a href="https://twitter.com/{{ author }}" target="_blank" title="@{{ author }} on Twitter">
@{{ author }} on Twitter
</a>
</li>
{% endif %}
{% if config.extra.author.github %}
{% set author = config.extra.author.github %}
<li>
<a href="https://github.com/{{ author }}" target="_blank" title="@{{ author }} on GitHub">
@{{ author }} on GitHub
</a>
</li>
{% endif %}
</ul>
{% endif %}
</ul>
</div>
</div>
</div>
</nav>
+1 -1
View File
@@ -1,5 +1,5 @@
{% if include_next_prev %}
<nav class="pagination" aria-label="footer navigation">
<nav class="pagination" aria-label="Footer">
<div class="previous">
{% if previous_page %}
<a href="{{ previous_page.url }}" title="{{ previous_page.title }}">
+1 -1
View File
@@ -1,4 +1,4 @@
<nav aria-label="top navigation">
<nav aria-label="Header">
<div class="bar default">
<div class="button button-menu" role="button" aria-label="Menu">
<label class="toggle-button icon icon-menu" for="toggle-drawer">
+4 -4
View File
@@ -1,6 +1,6 @@
{
"assets/images/favicon.ico": "assets/images/favicon-e565ddfa.ico",
"assets/javascripts/application.js": "assets/javascripts/application-d84ecdee.js",
"assets/javascripts/modernizr.js": "assets/javascripts/modernizr-79394028.js",
"assets/stylesheets/application.css": "assets/stylesheets/application-334f02ec.css"
"assets/images/favicon.ico": "assets/images/favicon-e565ddfa3b.ico",
"assets/javascripts/application.js": "assets/javascripts/application-c6d2e828bd.js",
"assets/javascripts/modernizr.js": "assets/javascripts/modernizr-4ab42b99fd.js",
"assets/stylesheets/application.css": "assets/stylesheets/application-f5ffeca01e.css"
}
-1
View File
@@ -1,6 +1,5 @@
{% if nav_item.children %}
<li>
<hr>
<span class="section">{{ nav_item.title }}</span>
<ul>
{% for nav_item in nav_item.children %}
+4 -1
View File
@@ -36,8 +36,11 @@ theme_dir: material
# Options
extra:
version: 0.1.0
version: 0.1.2
logo: images/logo.png
font:
text: Ubuntu
code: Ubuntu Mono
author:
github: squidfunk
twitter: squidfunk
+23 -26
View File
@@ -1,6 +1,6 @@
{
"name": "Material",
"version": "0.1.0",
"name": "mkdocs-material",
"version": "0.1.2",
"description": "A material design theme for MkDocs",
"homepage": "http://squidfunk.github.io/mkdocs-material/",
"authors": [
@@ -17,32 +17,29 @@
},
"private": true,
"devDependencies": {
"autoprefixer-core": "^5.1.11",
"css-mqpacker": "^3.1.0",
"del": "^1.1.1",
"gulp": "^3.8.11",
"autoprefixer": "^6.3.2",
"css-mqpacker": "^4.0.0",
"del": "^2.2.0",
"gulp": "^3.9.1",
"gulp-add-src": "^0.2.0",
"gulp-concat": "^2.5.2",
"gulp-debug": "^2.0.1",
"gulp-htmlmin": "^1.1.1",
"gulp-if": "^1.2.5",
"gulp-ignore": "^1.2.1",
"gulp-concat": "^2.6.0",
"gulp-cssnano": "^2.1.1",
"gulp-htmlmin": "^1.3.0",
"gulp-if": "^2.0.0",
"gulp-ignore": "^2.0.1",
"gulp-image-optimization": "^0.1.3",
"gulp-match": "^0.2.1",
"gulp-minify-css": "^1.1.0",
"gulp-modernizr": "^1.0.0-alpha",
"gulp-plumber": "^1.0.0",
"gulp-postcss": "^5.1.3",
"gulp-modernizr": "0.0.0",
"gulp-plumber": "^1.1.0",
"gulp-postcss": "^6.1.0",
"gulp-remove-empty-lines": "0.0.2",
"gulp-rev": "^3.0.1",
"gulp-rev-collector": "^1.0.0",
"gulp-sass": "^2.0.3",
"gulp-sourcemaps": "^1.5.2",
"gulp-sync": "^0.1.4",
"gulp-uglify": "^1.2.0",
"gulp-util": "^3.0.4",
"node-notifier": "^4.2.1",
"vinyl-paths": "^1.0.0",
"yargs": "^3.8.0"
"gulp-rev": "^7.0.0",
"gulp-rev-collector": "^1.0.2",
"gulp-sass": "^2.2.0",
"gulp-sourcemaps": "^1.6.0",
"gulp-uglify": "^1.5.2",
"gulp-util": "^3.0.7",
"node-notifier": "^4.5.0",
"vinyl-paths": "^2.1.0",
"yargs": "^3.32.0"
}
}
+1 -1
View File
@@ -23,7 +23,7 @@ from setuptools import setup, find_packages
# Package description
setup(
name = 'mkdocs-material',
version = '0.1.0',
version = '0.1.2',
url = 'http://squidfunk.github.io/mkdocs-material/',
license = 'MIT',
description = 'A material design theme for MkDocs',
Binary file not shown.
+346 -294
View File
@@ -1,296 +1,348 @@
{
"IcoMoonType": "selection",
"icons": [
{
"icon": {
"paths": [
"M661.333 597.333h-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.733v33.707l213.333 212.907 63.573-63.573-212.907-213.333zM405.333 597.333c-106.027 0-192-85.973-192-192s85.973-192 192-192 192 85.973 192 192-85.973 192-192 192z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"search"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 0,
"order": 7,
"prevSize": 24,
"code": 58880,
"name": "search"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 0
},
{
"icon": {
"paths": [
"M853.333 469.333h-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.253v-85.333z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"arrow-back"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 1,
"order": 4,
"prevSize": 24,
"code": 58881,
"name": "arrow-back"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 1
},
{
"icon": {
"paths": [
"M426.667 256l-60.373 60.373 195.627 195.627-195.627 195.627 60.373 60.373 256-256z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"chevron-right"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 2,
"order": 9,
"prevSize": 24,
"code": 58882,
"name": "chevron-right"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 2
},
{
"icon": {
"paths": [
"M810.667 273.707l-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"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"close"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 3,
"order": 8,
"prevSize": 24,
"code": 58883,
"name": "close"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 3
},
{
"icon": {
"paths": [
"M128 768h768v-85.333h-768v85.333zM128 554.667h768v-85.333h-768v85.333zM128 256v85.333h768v-85.333h-768z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"menu"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 4,
"order": 10,
"prevSize": 24,
"code": 58884,
"name": "menu"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 4
},
{
"icon": {
"paths": [
"M512 170.667l-60.373 60.373 238.293 238.293h-519.253v85.333h519.253l-238.293 238.293 60.373 60.373 341.333-341.333z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"arrow-forward"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 5,
"order": 15,
"prevSize": 24,
"code": 58885,
"name": "arrow-forward"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 5
},
{
"icon": {
"paths": [
"M1024 194.418c-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"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"twitter",
"brand",
"tweet",
"social"
],
"defaultCode": 58525,
"grid": 24
},
"attrs": [],
"properties": {
"id": 6,
"order": 9,
"prevSize": 24,
"code": 58886,
"ligatures": "twitter, brand11",
"name": "twitter"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 6
},
{
"icon": {
"paths": [
"M810.667 384h-170.667v-256h-256v256h-170.667l298.667 298.667 298.667-298.667zM213.333 768v85.333h597.333v-85.333h-597.333z"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"file-download"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 7,
"order": 10,
"prevSize": 24,
"code": 58888,
"name": "download"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 7
},
{
"icon": {
"paths": [
"M512 736.853l263.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"
],
"attrs": [],
"isMulticolor": false,
"tags": [
"star"
],
"grid": 24
},
"attrs": [],
"properties": {
"id": 8,
"order": 9,
"prevSize": 24,
"code": 58889,
"name": "star"
},
"setIdx": 1,
"setId": 4,
"iconIdx": 8
},
{
"icon": {
"paths": [
"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": [
"github",
"brand",
"octacat",
"social"
],
"grid": 24
},
"attrs": [],
"properties": {
"order": 27,
"prevSize": 24,
"ligatures": "github, brand40",
"name": "github",
"id": 433,
"code": 58887
},
"setIdx": 5,
"setId": 0,
"iconIdx": 432
}
],
"height": 1024,
"metadata": {
"name": "icon"
},
"preferences": {
"showGlyphs": true,
"showQuickUse": true,
"showQuickUse2": true,
"showSVGs": true,
"fontPref": {
"prefix": "icon-",
"metadata": {
"fontFamily": "icon",
"majorVersion": 1,
"minorVersion": 0
},
"metrics": {
"emSize": 1024,
"baseline": 6.25,
"whitespace": 50
},
"ie7": true,
"showSelector": true,
"selector": "class",
"classSelector": ".icon",
"showMetrics": true,
"showMetadata": true,
"cssVars": true,
"embed": false,
"noie8": false
},
"imagePref": {
"prefix": "icon-",
"png": true,
"useClassSelector": true,
"color": 4473924,
"bgColor": 16777215
},
"historySize": 100,
"showCodes": true,
"gridSize": 16
}
  "IcoMoonType": "selection",
  "icons": [
    {
      "icon": {
        "paths": [
          "M661.333 597.333h-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.733v33.707l213.333 212.907 63.573-63.573-212.907-213.333zM405.333 597.333c-106.027 0-192-85.973-192-192s85.973-192 192-192 192 85.973 192 192-85.973 192-192 192z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "search"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 0,
        "order": 7,
        "prevSize": 24,
        "code": 58880,
        "name": "search"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 0
    },
    {
      "icon": {
        "paths": [
          "M853.333 469.333h-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.253v-85.333z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "arrow-back"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 1,
        "order": 4,
        "prevSize": 24,
        "code": 58881,
        "name": "arrow-back"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 1
    },
    {
      "icon": {
        "paths": [
          "M426.667 256l-60.373 60.373 195.627 195.627-195.627 195.627 60.373 60.373 256-256z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "chevron-right"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 2,
        "order": 9,
        "prevSize": 24,
        "code": 58882,
        "name": "chevron-right"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 2
    },
    {
      "icon": {
        "paths": [
          "M810.667 273.707l-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"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "close"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 3,
        "order": 8,
        "prevSize": 24,
        "code": 58883,
        "name": "close"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 3
    },
    {
      "icon": {
        "paths": [
          "M128 768h768v-85.333h-768v85.333zM128 554.667h768v-85.333h-768v85.333zM128 256v85.333h768v-85.333h-768z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "menu"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 4,
        "order": 10,
        "prevSize": 24,
        "code": 58884,
        "name": "menu"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 4
    },
    {
      "icon": {
        "paths": [
          "M512 170.667l-60.373 60.373 238.293 238.293h-519.253v85.333h519.253l-238.293 238.293 60.373 60.373 341.333-341.333z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "arrow-forward"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 5,
        "order": 15,
        "prevSize": 24,
        "code": 58885,
        "name": "arrow-forward"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 5
    },
    {
      "icon": {
        "paths": [
          "M1024 194.418c-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"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "twitter",
          "brand",
          "tweet",
          "social"
        ],
        "defaultCode": 58525,
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 6,
        "order": 9,
        "prevSize": 24,
        "code": 58886,
        "ligatures": "twitter, brand11",
        "name": "twitter"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 6
    },
    {
      "icon": {
        "paths": [
          "M810.667 384h-170.667v-256h-256v256h-170.667l298.667 298.667 298.667-298.667zM213.333 768v85.333h597.333v-85.333h-597.333z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "file-download"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 7,
        "order": 10,
        "prevSize": 24,
        "code": 58888,
        "name": "download"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 7
    },
    {
      "icon": {
        "paths": [
          "M512 736.853l263.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"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "star"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "id": 8,
        "order": 9,
        "prevSize": 24,
        "code": 58889,
        "name": "star"
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 8
    },
    {
      "icon": {
        "paths": [
          "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": [
          "github",
          "brand",
          "octacat",
          "social"
        ],
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "order": 27,
        "prevSize": 24,
        "ligatures": "github, brand40",
        "name": "github",
        "id": 9,
        "code": 58887
      },
      "setIdx": 0,
      "setId": 3,
      "iconIdx": 9
    },
    {
      "icon": {
        "paths": [
          "M554 598v-172h-84v172h84zM554 768v-86h-84v86h84zM42 896l470-810 470 810h-940z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "warning"
        ],
        "defaultCode": 57346,
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "order": 11,
        "prevSize": 24,
        "name": "warning",
        "ligatures": "warning",
        "id": 2,
        "code": 58896
      },
      "setIdx": 1,
      "setId": 2,
      "iconIdx": 2
    },
    {
      "icon": {
        "paths": [
          "M614 256h240v426h-300l-16-84h-240v298h-84v-726h384z"
        ],
        "attrs": [],
        "isMulticolor": false,
        "tags": [
          "flag"
        ],
        "defaultCode": 57683,
        "grid": 24
      },
      "attrs": [],
      "properties": {
        "order": 13,
        "prevSize": 24,
        "name": "note",
        "ligatures": "flag",
        "id": 140,
        "code": 58897
      },
      "setIdx": 1,
      "setId": 2,
      "iconIdx": 140
    }
  ],
  "height": 1024,
  "metadata": {
    "name": "icon"
  },
  "preferences": {
    "showGlyphs": true,
    "showQuickUse": true,
    "showQuickUse2": true,
    "showSVGs": true,
    "fontPref": {
      "prefix": "icon-",
      "metadata": {
        "fontFamily": "icon",
        "majorVersion": 1,
        "minorVersion": 0
      },
      "metrics": {
        "emSize": 1024,
        "baseline": 6.25,
        "whitespace": 50
      },
      "ie7": true,
      "showSelector": true,
      "selector": "class",
      "classSelector": ".icon",
      "showMetrics": true,
      "showMetadata": true,
      "cssVars": true,
      "embed": false,
      "noie8": false
    },
    "imagePref": {
      "prefix": "icon-",
      "png": true,
      "useClassSelector": true,
      "color": 4473924,
      "bgColor": 16777215
    },
    "historySize": 100,
    "showCodes": true,
    "gridSize": 16
  }
}
+2
View File
@@ -17,4 +17,6 @@
<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="warning" d="M554 340.667v172h-84v-172h84zM554 170.667v86h-84v-86h84zM42 42.667l470 810 470-810h-940z" />
<glyph unicode="&#xe611;" glyph-name="hint" d="M614 682.667h240v-426h-300l-16 84h-240v-298h-84v726h384z" />
</font></defs></svg>

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.
Binary file not shown.
+2 -2
View File
@@ -508,9 +508,9 @@ document.addEventListener('DOMContentLoaded', function() {
function(data, xhr) {
var count = data.stargazers_count;
if (count > 10000)
count = (count / 1000).toFixed(0) + "k";
count = (count / 1000).toFixed(0) + 'k';
else if (count > 1000)
count = (count / 1000).toFixed(1) + "k";
count = (count / 1000).toFixed(1) + 'k';
/* Set number of stars */
var stars = document.querySelector('.repo-stars .count');
+1 -8
View File
@@ -24,13 +24,6 @@
* Code highlighter
* ------------------------------------------------------------------------- */
/*
* Inline code
*/
code {
color: $primary;
}
/*
* Code block
*/
@@ -69,7 +62,7 @@ pre {
/*
* Strings
*/
.s {
.s, .s1 {
color: #183691;
}
+12 -1
View File
@@ -32,7 +32,7 @@
/*
* Hide non-relevant elements
*/
.header, .project, .footer {
.header, .drawer, .headerlink, .footer {
display: none;
}
@@ -41,6 +41,13 @@
*/
.article {
/*
* Remove top spacing
*/
.wrapper {
padding-top: 0;
}
/*
* Remove color in all code blocks
*/
@@ -48,6 +55,10 @@
color: $black !important;
}
pre {
border: 1px solid $black-lightest;
}
/*
* Border-radius makes this table entirely black on paper, so scrap it
*/
+28 -20
View File
@@ -21,28 +21,22 @@
*/
/* ----------------------------------------------------------------------------
* Font faces
* Font faces - defined in base.html for correct path resolution
* ------------------------------------------------------------------------- */
/*
* Base URL and path for icon font.
*/
$base: '../..';
$path: $base + '/assets/fonts/';
/*
* Icon font
*/
@font-face {
font-family: 'Icon';
src: url($path + 'icon.eot?52m981');
src: url($path + 'icon.eot?#iefix52m981') format('embedded-opentype'),
url($path + 'icon.woff?52m981') format('woff'),
url($path + 'icon.ttf?52m981') format('truetype'),
url($path + 'icon.svg?52m981#icon') format('svg');
font-weight: normal;
font-style: normal;
}
// /*
// * Icon font
// */
// @font-face {
// font-family: 'Icon';
// src: url('/assets/fonts/icon.eot?52m981');
// src: url('/assets/fonts/icon.eot?#iefix52m981') format('embedded-opentype'),
// url('/assets/fonts/icon.woff?52m981') format('woff'),
// url('/assets/fonts/icon.ttf?52m981') format('truetype'),
// url('/assets/fonts/icon.svg?52m981#icon') format('svg');
// font-weight: normal;
// font-style: normal;
// }
/* ----------------------------------------------------------------------------
* Representational classes
@@ -133,4 +127,18 @@ $path: $base + '/assets/fonts/';
*/
.icon-star:before {
content: "\e609";
}
/*
* Warning icon
*/
.icon-warning:before {
content: "\e610";
}
/*
* Star icon
*/
.icon-note:before {
content: "\e611";
}
@@ -44,9 +44,9 @@
}
/*
* Headlines and chapters in primary color
* Headlines, chapters, links and inline code
*/
h1, h2 {
h1, h2, a, code {
color: $primary;
}
@@ -58,18 +58,18 @@
}
/*
* Color links
* Hovered and focused links
*/
a {
color: $primary;
a:hover,
a:focus {
color: $accent;
}
/*
* Hovered link
*/
&:hover,
&:focus {
color: $accent;
}
/*
* Light permalinks
*/
.headerlink {
color: $black-lighter;
}
/*
@@ -134,10 +134,8 @@
/*
* Inherit color for links
*/
a,
a:hover,
a:focus {
color: inherit;
a .title, a .button {
color: $white;
}
/*
@@ -152,7 +150,8 @@
* Admonition support
*/
.admonition {
background: mix($light-blue-500, $white, 10%);
background: $light-blue-400;
color: $white;
/*
* Embedded code blocks
@@ -165,17 +164,6 @@
* A warning hint
*/
&.warning {
background: mix($red-500, $white, 10%);
}
}
/*
* Permalink support
*/
.article {
h2, h3, h4, h5, h6 {
a {
color: $black-lighter;
}
background: $red-400;
}
}
@@ -126,6 +126,22 @@
}
}
/*
* Align permalinks on the right
*/
.headerlink {
float: right;
margin-left: 20px;
font-size: 14px;
/*
* Hide permalink to main headline
*/
h1 & {
display: none;
}
}
/*
* Paragraphs and section titles
*/
@@ -514,27 +530,31 @@
margin: 20px -24px 0;
padding: 20px 24px;
}
}
/*
* Permalink support
*/
.article {
/*
* Hide link to main headline
* Admonition title, if given
*/
h1 a {
display: none;
}
.admonition-title {
font-size: 20px;
/*
* Align permalinks on the right
*/
h2, h3, h4, h5, h6 {
a {
float: right;
margin-left: 20px;
/*
* Default icon
*/
&:before {
content: "\e611";
display: block;
float: left;
font-family: 'Icon';
font-size: 24px;
vertical-align: -0.1em;
margin-right: 5px;
}
}
/*
* Warning icon
*/
&.warning .admonition-title:before {
content: "\e610";
}
}
@@ -45,13 +45,6 @@
}
}
/*
* Admonition support
*/
.admonition-title {
font-weight: 700;
}
/*
* Permalink support
*/
@@ -28,7 +28,7 @@
* Default font styles
*/
body, input {
font-family: 'Ubuntu', 'Helvetica Neue', Helvetica, Arial, sans-serif;
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
font-weight: 400;
/* Enable font-smoothing in Webkit and FF */
@@ -47,7 +47,7 @@ body, input {
* Proportional fonts
*/
pre, code {
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
font-family: 'Courier New', 'Courier', monospace;
/*
* Use system fonts, if browser doesn't support webfonts
@@ -31,7 +31,7 @@
/* [tablet landscape-]: Light gray background */
@include break-to-device(tablet landscape) {
background: darken($white, 5%);
background: $white;
}
/*
@@ -50,27 +50,23 @@
* Hovered link
*/
&:hover, &:focus {
color: $accent;
color: $primary;
}
}
/*
* Color anchors menu
*/
.anchor a {
border-left: 2px solid $primary;
}
/*
* Main sections
*/
.section {
color: $black-light;
}
/*
* Content wrapper
*/
.wrapper {
/* [tablet landscape-]: Light gray background */
@include break-to-device(tablet landscape) {
background: darken($white, 5%);
}
}
}
/*
@@ -106,7 +102,7 @@
*/
&:hover .logo img,
&:focus .logo img {
@include drop-shadow(3);
@include drop-shadow(2);
}
}
@@ -114,8 +110,6 @@
* Repository buttons
*/
.repo a {
@include drop-shadow(1);
background: $accent;
color: $white;
border-radius: 3px;
@@ -124,7 +118,7 @@
* Hovered button
*/
&:hover, &:focus {
@include drop-shadow(3);
@include drop-shadow(2);
opacity: 0.8;
}
@@ -66,10 +66,25 @@
}
/*
* Links to chapters inside the current article
* Links to anchors
*/
.toc li.anchor a {
padding: 10px 24px 10px 48px;
margin-left: 12px;
padding: 10px 24px 10px 12px;
}
/*
* Nested links
*/
.toc li ul {
margin-left: 12px;
}
/*
*
*/
.current + ul {
margin-bottom: 9px;
}
/*
@@ -77,7 +92,6 @@
*/
.section {
display: block;
font-size: 11px;
padding: 14.5px 24px;
}
@@ -47,7 +47,6 @@
* Main sections
*/
.section {
text-transform: uppercase;
font-weight: 700;
}
}
+69 -9
View File
@@ -64,15 +64,52 @@
<link rel="icon" type="image/x-icon"
href="{{ base_url }}/{{ icon }}" />
<!-- Webfonts -->
<link rel="stylesheet" type="text/css"
href="https://fonts.googleapis.com/css?family=Ubuntu:400,700" />
<link rel="stylesheet" type="text/css"
href="https://fonts.googleapis.com/css?family=Ubuntu+Mono" />
<!-- Configure icons (placed here to omit issues with subdirectories) -->
<style>
@font-face {
font-family: 'Icon';
src: url('{{ base_url }}/assets/fonts/icon.eot?52m981');
src: url('{{ base_url }}/assets/fonts/icon.eot?#iefix52m981')
format('embedded-opentype'),
url('{{ base_url }}/assets/fonts/icon.woff?52m981')
format('woff'),
url('{{ base_url }}/assets/fonts/icon.ttf?52m981')
format('truetype'),
url('{{ base_url }}/assets/fonts/icon.svg?52m981#icon')
format('svg');
font-weight: normal;
font-style: normal;
}
</style>
<!-- Theme-related and custom stylesheets -->
<!-- Theme-related stylesheets -->
<link rel="stylesheet" type="text/css"
href="{{ base_url }}/assets/stylesheets/application.css" />
<!-- Configure webfonts -->
{% if config.extra.font != 'none' %}
{% set text = 'Ubuntu' %}
{% if config.extra.font and config.extra.font.text %}
{% set text = config.extra.font.text %}
{% endif %}
{% set code = 'Ubuntu Mono' %}
{% if config.extra.font and config.extra.font.code %}
{% set code = config.extra.font.code %}
{% endif %}
{% set font = text + ':400,700|' + code | replace('+', ' ') %}
<link rel="stylesheet" type="text/css"
href="//fonts.googleapis.com/css?family={{ font }}" />
<style>
body, input {
font-family: '{{ text }}', Helvetica, Arial, sans-serif;
}
pre, code {
font-family: '{{ code }}', 'Courier New', 'Courier', monospace;
}
</style>
{% endif %}
<!-- Custom stylesheets -->
{% for path in extra_css %}
<link rel="stylesheet" type="text/css" href="{{ path }}" />
{% endfor %}
@@ -82,6 +119,18 @@
</head>
<body>
<!--
Sadly the jinja template engine is not very flexible - it doesn't support
regular expressions out-of-the-box. Since there might be a slash at the
end of the repository name, we just do a string comparison and kill it.
-->
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
{% if repo_id[-1:] == '/' %}
{% set repo_id = repo_id[:-1] %}
{% endif %}
{% endif %}
<!-- Backdrop -->
<div class="backdrop">
<div class="backdrop-paper"></div>
@@ -139,7 +188,7 @@
Documentation built with
<a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
using the
<a href="https://github.com/squidfunk/mkdocs-material"
<a href="http://squidfunk.github.io/mkdocs-material/"
target="_blank">
Material
</a>
@@ -170,7 +219,6 @@
<script src="{{ base_url }}/assets/javascripts/modernizr.js"></script>
<!-- Theme-related and custom javascripts -->
{% set repo_id = repo_url | replace('https://github.com/', '') %}
<script>
var base_url = '{{ base_url }}';
var repo_id = '{{ repo_id }}';
@@ -189,11 +237,23 @@
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');
'script', '//www.google-analytics.com/analytics.js', 'ga');
/* General initialization */
ga('create', '{{ google_analytics[0] }}', '{{ google_analytics[1] }}');
ga('set', 'anonymizeIp', true);
ga('send', 'pageview');
/* Track outbound links */
var buttons = document.querySelectorAll('a');
Array.prototype.map.call(buttons, function(item) {
if (item.host != window.location.host) {
item.addEventListener('click', function() {
var action = item.getAttribute('data-action') || 'follow';
ga('send', 'event', 'outbound', action, item.href);
});
}
});
</script>
{% endif %}
</body>
+39 -40
View File
@@ -1,9 +1,5 @@
{% if repo_name == 'GitHub' %}
{% set repo_id = repo_url | replace('https://github.com/', '') %}
{% endif %}
<!-- Navigation -->
<nav aria-label="navigation">
<nav aria-label="Navigation">
<!-- Project information -->
<a href="{{ repo_url }}" class="project">
@@ -39,14 +35,17 @@
{% 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">
{% set version = config.extra.version | default('master') %}
<a href="{{ repo_url }}/archive/{{ version }}.zip" target="_blank"
title="Download {{ site_name }} from GitHub"
data-action="download">
<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">
<a href="{{ repo_url }}" target="_blank"
title="Star {{ site_name }} on GitHub"
data-action="star">
<i class="icon icon-star"></i> Star
<span class="count">&ndash;</span>
</a>
@@ -56,43 +55,43 @@
{% endif %}
<!-- Table of contents -->
<ul class="toc">
{% for nav_item in nav %}
{% include "nav.html" %}
{% endfor %}
<div class="toc">
<ul>
{% for nav_item in nav %}
{% include "nav.html" %}
{% endfor %}
</ul>
<!-- Author-related links -->
{% if config.extra.author %}
<li>
<hr />
<span class="section">The author</span>
<ul>
<hr />
<span class="section">The author</span>
<ul>
<!-- Twitter -->
{% 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 %}
<!-- Twitter -->
{% if config.extra.author.twitter %}
{% set author = config.extra.author.twitter %}
<li>
<a href="https://twitter.com/{{ author }}" target="_blank"
title="@{{ author }} on Twitter">
@{{ author }} on Twitter
</a>
</li>
{% endif %}
<!-- GitHub -->
{% 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>
<!-- GitHub -->
{% if config.extra.author.github %}
{% set author = config.extra.author.github %}
<li>
<a href="https://github.com/{{ author }}" target="_blank"
title="@{{ author }} on GitHub">
@{{ author }} on GitHub
</a>
</li>
{% endif %}
</ul>
{% endif %}
</ul>
</div>
</div>
</div>
</nav>
+1 -1
View File
@@ -1,6 +1,6 @@
<!-- Previous and next page -->
{% if include_next_prev %}
<nav class="pagination" aria-label="footer navigation">
<nav class="pagination" aria-label="Footer">
<!-- Previous page -->
<div class="previous">
+1 -1
View File
@@ -1,5 +1,5 @@
<!-- Top-level navigation -->
<nav aria-label="top navigation">
<nav aria-label="Header">
<!-- Default bar -->
<div class="bar default">
-1
View File
@@ -1,7 +1,6 @@
<!-- Render sections -->
{% if nav_item.children %}
<li>
<hr />
<span class="section">{{ nav_item.title }}</span>
<ul>