Preparing release

.gitignore

@@ -28,7 +28,8 @@ node_modules
 # Build files
 build
 MANIFEST
+site
 
 # Distribution files
 dist
-mkdocs_materializr.egg-info
+mkdocs_material.egg-info

CHANGELOG

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

Gulpfile.js

@@ -105,7 +105,7 @@ gulp.task('assets:stylesheets', function() {
       ]))
     .pipe(gulpif(args.sourcemaps, sourcemaps.write()))
     .pipe(gulpif(args.production, mincss()))
-    .pipe(gulp.dest('materializr/assets/stylesheets/'));
+    .pipe(gulp.dest('material/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('materializr/assets/javascripts/'));
+    .pipe(gulp.dest('material/assets/javascripts/'));
 });
 
 /*
@@ -138,8 +138,8 @@ gulp.task('assets:modernizr', [
   'assets:javascripts'
 ], function() {
   return gulp.src([
-    'materializr/assets/stylesheets/application.css',
+    'material/assets/stylesheets/application.css',
-    'materializr/assets/javascripts/application.js'
+    'material/assets/javascripts/application.js'
   ]).pipe(
       modernizr({
         options: [
@@ -153,22 +153,22 @@ 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('materializr/assets/javascripts'));
+    .pipe(gulp.dest('material/assets/javascripts'));
 });
 
 /*
  * Copy static assets like images and webfonts.
  */
 gulp.task('assets:static', function() {
-  return gulp.src('src/assets/{fonts,images}/*.{ico,jpg,png,gif}')
+  return gulp.src('src/assets/{fonts,images}/*.{jpg,png,gif}')
     .pipe(gulpif(args.production,
       minimage({
         optimizationLevel: 5,
         progressive: true,
         interlaced: true
       })))
-    .pipe(addsrc.append('src/assets/{fonts,images}/*.{eot,svg,ttf,woff}'))
+    .pipe(addsrc.append('src/assets/{fonts,images}/*.{ico,eot,svg,ttf,woff}'))
-    .pipe(gulp.dest('materializr/assets/'));
+    .pipe(gulp.dest('material/assets/'));
 });
 
 /*
@@ -191,20 +191,20 @@ gulp.task('assets:views', args.production ? [
     .pipe(compact())
     .pipe(gulpif(args.production,
       addsrc.append([
-        'materializr/manifest.json',
+        'material/manifest.json',
-        'materializr/**/*.css'
+        'material/**/*.css'
       ])))
     .pipe(gulpif(args.production, collect()))
     .pipe(ignore.exclude(/manifest\.json$/))
-    .pipe(gulp.dest('materializr'));
+    .pipe(gulp.dest('material'));
 });
 
 /*
  * Clean outdated revisions.
  */
 gulp.task('assets:revisions:clean', function() {
-  return gulp.src(['materializr/**/*.{css,js,png,jpg,gif}'])
+  return gulp.src(['material/**/*.{ico,css,js,png,jpg,gif}'])
-    .pipe(ignore.include(/-[a-f0-9]{8}\.(css|js|png|jpg|gif)$/))
+    .pipe(ignore.include(/-[a-f0-9]{8}\.(ico|css|js|png|jpg|gif)$/))
     .pipe(vinyl(clean));
 });
 
@@ -217,12 +217,12 @@ gulp.task('assets:revisions', [
   'assets:javascripts',
   'assets:static'
 ], function() {
-  return gulp.src(['materializr/**/*.{css,js,png,jpg,gif}'])
+  return gulp.src(['material/**/*.{ico,css,js,png,jpg,gif}'])
     .pipe(ignore.exclude(/-[a-f0-9]{8}\.(css|js|png|jpg|gif)$/))
     .pipe(rev())
-    .pipe(gulp.dest('materializr'))
+    .pipe(gulp.dest('material'))
     .pipe(rev.manifest('manifest.json'))
-    .pipe(gulp.dest('materializr'));
+    .pipe(gulp.dest('material'));
 });
 
 /*

MANIFEST.in

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

README.txt

@@ -1,4 +1,4 @@
-materializr
+mkdocs-material
 ===========
 
 A material design theme for MkDocs

bower.json

@@ -1,8 +1,8 @@
 {
-  "name": "materializr",
+  "name": "mkdocs-material",
   "version": "0.1.0",
   "description": "A material design theme for MkDocs",
-  "homepage": "https://github.com/squidfunk/materializr",
+  "homepage": "https://github.com/squidfunk/mkdocs-material",
   "authors": [
     "squidfunk <martin.donath@squidfunk.com>"
   ],

material/assets/stylesheets/application.css

@@ -1555,6 +1555,28 @@ pre span {
   .pagination .direction {
     color: rgba(255, 255, 255, 0.7); }
 
+/*
+ * Admonition support
+ */
+.admonition {
+  background: #eceef8;
+  /*
+   * Embedded code blocks
+   */
+  /*
+   * A warning hint
+   */ }
+  .admonition pre {
+    background: rgba(255, 255, 255, 0.3); }
+  .admonition.warning {
+    background: #fce8e9; }
+
+/*
+ * Permalink support
+ */
+.article h2 a, .article h3 a, .article h4 a, .article h5 a, .article h6 a {
+  color: rgba(0, 0, 0, 0.26); }
+
 /*
  * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
  *
@@ -1585,6 +1607,7 @@ pre span {
 .article {
   font-size: 14px;
   line-height: 1.7em;
+  overflow-x: hidden;
   /* [tablet landscape+]: Indent to account for drawer */
   /*
    * Clearfix
@@ -1672,8 +1695,16 @@ pre span {
       padding-top: 36px;
       margin: 0; }
   .article h3, .article h4 {
-    font-size: 1.0em; }
+    font-size: 14px;
-  .article p, .article h3, .article h4, .article ul, .article ol {
+    padding-top: 76px;
+    margin-top: -56px;
+    /*
+     * No offset correction in iOS web application
+     */ }
+    .ios.standalone .article h3, .ios.standalone .article h4 {
+      padding-top: 20px;
+      margin-top: 0; }
+  .article p, .article ul, .article ol {
     margin-top: 1.5em; }
   .article li {
     margin-top: 0.75em;
@@ -1841,6 +1872,35 @@ pre span {
       font-size: 18px;
       padding: 11px 0 13px; }
 
+/*
+ * Admonition support
+ */
+.admonition {
+  margin: 20px -16px 0;
+  padding: 20px 16px;
+  /*
+   * Remove redundant margin of first child
+   */
+  /* [tablet portait+]: Increase horizontal spacing */ }
+  .admonition > :first-child {
+    margin-top: 0; }
+
+/*
+ * Permalink support
+ */
+.article {
+  /*
+   * Hide link to main headline
+   */
+  /*
+   * Align permalinks on the right
+   */ }
+  .article h1 a {
+    display: none; }
+  .article h2 a, .article h3 a, .article h4 a, .article h5 a, .article h6 a {
+    float: right;
+    margin-left: 20px; }
+
 /*
  * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
  *
@@ -1881,6 +1941,19 @@ pre span {
     font-weight: 400;
     font-style: italic; }
 
+/*
+ * Admonition support
+ */
+.admonition-title {
+  font-weight: 700; }
+
+/*
+ * Permalink support
+ */
+.article h2 a, .article h3 a, .article h4 a, .article h5 a, .article h6 a {
+  font-weight: 400;
+  font-style: normal; }
+
 /*
  * Copyright (c) 2016 Martin Donath <martin.donath@squidfunk.com>
  *
@@ -2362,8 +2435,6 @@ pre span {
 /* ----------------------------------------------------------------------------
  * Nothing to see here, move along
  * ------------------------------------------------------------------------- */
-.admonition {
-  background: red; }
 @media only screen and (min-width: 960px) {
   .backdrop {
     background: #f2f2f2; }
@@ -2445,6 +2516,8 @@ pre span {
   .article {/*
      * Account for larged header bar and anchors
      *//*
+     * Sub headlines
+     *//*
      * Increase spacing for code blocks
      */ }
   .article h2 {
@@ -2455,6 +2528,14 @@ pre span {
   .ios.standalone .article h2 {
     padding-top: 28px;
     margin-top: 8px; }
+  .article h3, .article h4 {
+    padding-top: 84px;
+    margin-top: -64px;/*
+       * No offset correction in iOS web application
+       */ }
+  .ios.standalone .article h3, .ios.standalone .article h4 {
+    padding-top: 20px;
+    margin-top: 0; }
   .article pre {
     padding: 1.5em 24px;
     margin: 1.5em -24px 0; }
@@ -2473,6 +2554,9 @@ pre span {
     bottom: 40px; }
   .pagination .stretch {
     padding: 0 8px; }
+  .admonition {
+    margin: 20px -24px 0;
+    padding: 20px 24px; }
   .bar.search .query {
     font-size: 20px;
     padding: 12px 0; }

material/base.html

@@ -28,16 +28,11 @@
     <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="shortcut icon" type="image/x-icon" href="{{ icon | default(base_url + '/assets/images/favicon.ico') }}">
-    <link rel="icon" type="image/x-icon" href="{{ icon | default('/assets/images/favicon.ico') }}">
+    <link rel="icon" type="image/x-icon" href="{{ icon | default(base_url + '/assets/images/favicon.ico') }}">
     <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">
-    {% if config.extra.color %}
-      {% set color = config.extra.color %}
-      <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application.{{ color }}.css">
-    {% else %}
     <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application.css">
-    {% endif %}
     {% for path in extra_css %}
       <link rel="stylesheet" href="{{ path }}">
     {% endfor %}
@@ -54,7 +49,7 @@
       {% include "header.html" %}
     </header>
     <main class="main">
-      {% set h1 = "\x3c/h1\x3e" in content %}
+      {% set h1 = "\x3ch1 id=" in content %}
       <div class="drawer">
         {% include "drawer.html" %}
       </div>
@@ -75,8 +70,8 @@
             Documentation built with
             <a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
             using the
-            <a href="https://github.com/squidfunk/materializr" target="_blank">
+            <a href="https://github.com/squidfunk/mkdocs-material" target="_blank">
-              Materializr
+              Material
             </a>
             theme.
           </aside>

material/manifest.json

@@ -0,0 +1,6 @@
+{
+  "assets/images/favicon.ico": "assets/images/favicon-e565ddfa.ico",
+  "assets/javascripts/application.js": "assets/javascripts/application-1a680198.js",
+  "assets/javascripts/modernizr.js": "assets/javascripts/modernizr-79394028.js",
+  "assets/stylesheets/application.css": "assets/stylesheets/application-9ec7095f.css"
+}

materializr/manifest.json

@@ -1,12 +0,0 @@
-{
-  "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"
-}

mkdocs.yml

@@ -19,25 +19,24 @@
 # IN THE SOFTWARE.
 
 # Project information
-site_name: materializr
+site_name: mkdocs-material
 site_description: A material design theme for MkDocs
 site_author: Martin Donath
-site_url: https://squidfunk.com/materializr
+site_url: https://github.com/squidfunk/mkdocs-material
 
 # Repository
 repo_name: GitHub
-repo_url: https://github.com/squidfunk/materializr
+repo_url: https://github.com/squidfunk/mkdocs-material
 
 # Copyright
 copyright: Copyright (c) 2016 Martin Donath
 
 # Documentation and theme
-docs_dir: docs
+theme_dir: material
-theme_dir: materializr
+theme: amelia
 
 # Extra variables
 extra:
-  color:
   version: 0.1.0
   logo:
   author:
@@ -48,7 +47,10 @@ extra:
 markdown_extensions:
   - fenced_code
   - codehilite(css_class=code)
+  - admonition
+  - toc:
+      permalink: ¶
 
 # Page tree
 pages:
-  - About: index.md
+- Home: index.md

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "materializr",
+  "name": "mkdocs-material",
   "version": "0.1.0",
   "description": "A material design theme for MkDocs",
-  "homepage": "https://github.com/squidfunk/materializr",
+  "homepage": "https://github.com/squidfunk/mkdocs-material",
   "authors": [
     "squidfunk <martin.donath@squidfunk.com>"
   ],
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/squidfunk/materializr.git"
+    "url": "https://github.com/squidfunk/mkdocs-material.git"
   },
   "private": true,
   "devDependencies": {

setup.py

@@ -22,9 +22,9 @@ from setuptools import setup, find_packages
 
 # Package description
 setup(
-    name = 'mkdocs-materializr',
+    name = 'mkdocs-material',
     version = '0.1.0',
-    url = 'https://github.com/squidfunk/materializr',
+    url = 'https://github.com/squidfunk/mkdocs-material',
     license = 'MIT',
     description = 'A material design theme for MkDocs',
     author = 'Martin Donath',
@@ -33,7 +33,7 @@ setup(
     include_package_data = True,
     entry_points = {
         'mkdocs.themes': [
-            'materializr = materializr',
+            'material = material',
         ]
     },
     zip_safe = False

src/assets/stylesheets/application.blue.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/application.green.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/application.grey.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/application.pink.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/application.purple.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/application.red.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/application.teal.scss

@@ -1,56 +0,0 @@
-/*
- * 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";

src/assets/stylesheets/modules/article/_appearance.scss

@@ -147,3 +147,35 @@
     color: $white-light;
   }
 }
+
+/*
+ * Admonition support
+ */
+.admonition {
+  background: mix($primary, $white, 10%);
+
+  /*
+   * Embedded code blocks
+   */
+  pre {
+    background: $white-lighter;
+  }
+
+  /*
+   * A warning hint
+   */
+  &.warning {
+    background: mix($red-500, $white, 10%);
+  }
+}
+
+/*
+ * Permalink support
+ */
+.article {
+  h2, h3, h4, h5, h6 {
+    a {
+      color: $black-lighter;
+    }
+  }
+}

src/assets/stylesheets/modules/article/_layout.scss

@@ -30,6 +30,7 @@
 .article {
   font-size: 14px;
   line-height: 1.7em;
+  overflow-x: hidden;
 
   /* [tablet landscape+]: Indent to account for drawer */
   @include break-from-device(tablet landscape) {
@@ -113,13 +114,23 @@
    * Sub headlines
    */
   h3, h4 {
-    font-size: 1.0em;
+    font-size: 14px;
+    padding-top: (20px + 56px);
+    margin-top: (0 - 56px);
+
+    /*
+     * No offset correction in iOS web application
+     */
+    .ios.standalone & {
+      padding-top: 20px;
+      margin-top: 0;
+    }
   }
 
   /*
    * Paragraphs and section titles
    */
-  p, h3, h4, ul, ol {
+  p, ul, ol {
     margin-top: 1.5em;
   }
 
@@ -271,6 +282,22 @@
       }
     }
 
+    /*
+     * Sub headlines
+     */
+    h3, h4 {
+      padding-top: (20px + 64px);
+      margin-top: (0 - 64px);
+
+      /*
+       * No offset correction in iOS web application
+       */
+      .ios.standalone & {
+        padding-top: 20px;
+        margin-top: 0;
+      }
+    }
+
     /*
      * Increase spacing for code blocks
      */
@@ -467,3 +494,47 @@
     }
   }
 }
+
+/*
+ * Admonition support
+ */
+.admonition {
+  margin: 20px -16px 0;
+  padding: 20px 16px;
+
+  /*
+   * Remove redundant margin of first child
+   */
+  > :first-child {
+    margin-top: 0;
+  }
+
+  /* [tablet portait+]: Increase horizontal spacing */
+  @include break-from-device(tablet portrait) {
+    margin: 20px -24px 0;
+    padding: 20px 24px;
+  }
+}
+
+/*
+ * Permalink support
+ */
+.article {
+
+  /*
+   * Hide link to main headline
+   */
+  h1 a {
+    display: none;
+  }
+
+  /*
+   * Align permalinks on the right
+   */
+  h2, h3, h4, h5, h6 {
+    a {
+      float: right;
+      margin-left: 20px;
+    }
+  }
+}

src/assets/stylesheets/modules/article/_typography.scss

@@ -44,3 +44,22 @@
     font-style: italic;
   }
 }
+
+/*
+ * Admonition support
+ */
+.admonition-title {
+  font-weight: 700;
+}
+
+/*
+ * Permalink support
+ */
+.article {
+  h2, h3, h4, h5, h6 {
+    a {
+      font-weight: 400;
+      font-style: normal;
+    }
+  }
+}

src/base.html

@@ -47,9 +47,9 @@
 
     <!-- Favicon -->
     <link rel="shortcut icon" type="image/x-icon"
-      href="{{ icon | default('/assets/images/favicon.ico') }}" />
+      href="{{ icon | default(base_url + '/assets/images/favicon.ico') }}" />
     <link rel="icon" type="image/x-icon"
-      href="{{ icon | default('/assets/images/favicon.ico') }}" />
+      href="{{ icon | default(base_url + '/assets/images/favicon.ico') }}" />
 
     <!-- Webfonts -->
     <link rel="stylesheet" type="text/css"
@@ -58,14 +58,8 @@
       href="https://fonts.googleapis.com/css?family=Ubuntu+Mono" />
 
     <!-- Theme-related and custom stylesheets -->
-    {% 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 %}
@@ -101,7 +95,7 @@
         necessary for correctly rendering the table of contents which is
         embedded into the navigation and the actual headline.
       -->
-      {% set h1 = "\x3c/h1\x3e" in content %}
+      {% set h1 = "\x3ch1 id=" in content %}
 
       <!-- Drawer with navigation -->
       <div class="drawer">
@@ -132,9 +126,9 @@
             Documentation built with
             <a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
             using the
-            <a href="https://github.com/squidfunk/materializr"
+            <a href="https://github.com/squidfunk/mkdocs-material"
               target="_blank">
-              Materializr
+              Material
             </a>
             theme.
           </aside>