Prepare 0.2.3 release

Update drawer.html // Styling version number

CHANGELOG

@@ -1,3 +1,16 @@
+mkdocs-material-0.2.3 (2016-05-16)
+
+  * Fixed #25: Highlight inline fenced blocks
+  * Fixed #26: Better highlighting for keystrokes
+  * Fixed #30: Suboptimal syntax highlighting for PHP
+
+mkdocs-material-0.2.2 (2016-03-20)
+
+  * Fixed #15: Document pygments dependency for codehilite
+  * Fixed #16: Favicon could not be set through mkdocs.yml
+  * Fixed #17: Put version into own container for styling
+  * Fixed #20: Fix rounded borders for tables
+
 mkdocs-material-0.2.1 (2016-03-12)
 
   * Fixed #10: Invisible header after closing search bar with ESC key

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "mkdocs-material",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "A material design theme for MkDocs",
   "homepage": "http://squidfunk.github.io/mkdocs-material/",
   "authors": [

docs/getting-started.md

@@ -205,8 +205,9 @@ have to switch them on explicitly.
 
 ### CodeHilite (recommended)
 
-This extensions adds code highlighting to fenced code blocks. It might not be
-the best code highlighter, but it works without JavaScript and on the server:
+This extensions uses [Pygments][] (install with `pip install pygments`) to add
+code highlighting to fenced code blocks. It might not be the best code
+highlighter, but it works without JavaScript and on the server:
 
 ``` yaml
 markdown_extensions:
@@ -220,12 +221,12 @@ further instructions
 ### Permalinks
 
 In order to add [permalinks][] to the headers of your article, set the
-`markdown_extensions.toc.permalink` variable to a symbol, e.g. `¶`:
+`markdown_extensions.toc.permalink` variable to a symbol, e.g. `#`:
 
 ``` yaml
 markdown_extensions:
   - toc:
-    permalink: '¶'
+    permalink: '#'
 ```
 
 The symbol can be chosen freely, it can even be a WebFont icon.
@@ -317,7 +318,7 @@ markdown_extensions:
   - codehilite(css_class=code)
   - admonition
   - toc:
-      permalink: '¶'
+      permalink: '#'
 ```
 
 [MkDocs]: http://www.mkdocs.org
@@ -326,6 +327,7 @@ markdown_extensions:
 [Google Fonts]: https://www.google.com/fonts
 [Roboto font]: https://www.google.com/fonts/specimen/Roboto
 [Markdown extensions]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
+[Pygments]: http://pygments.org
 [highlight.js]: https://highlightjs.org
 [extra]: http://www.mkdocs.org/user-guide/styling-your-docs/#customising-a-theme
 [permalinks]: https://en.wikipedia.org/wiki/Permalink

material/base.html

@@ -34,9 +34,9 @@
     {% if config.extra.logo %}
       <link rel="apple-touch-icon" href="{{ base_url }}/{{ config.extra.logo }}">
     {% endif %}
-    {% 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 }}">
+    {% set favicon = favicon | default("assets/images/favicon-e565ddfa3b.ico") %}
+    <link rel="shortcut icon" type="image/x-icon" href="{{ base_url }}/{{ favicon }}">
+    <link rel="icon" type="image/x-icon" href="{{ base_url }}/{{ favicon }}">
     <style>
       @font-face {
       	font-family: 'Icon';
@@ -53,7 +53,7 @@
       	font-style: normal;
       }
     </style>
-    <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-20d5debb47.css">
+    <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/application-0dac3e5884.css">
     {% if config.extra.palette %}
       <link rel="stylesheet" href="{{ base_url }}/assets/stylesheets/palettes-05ab2406df.css">
     {% endif %}

material/drawer.html

@@ -8,7 +8,12 @@
         </div>
       {% endif %}
       <div class="name">
-        <strong>{{ site_name }} {{ config.extra.version }}</strong>
+        <strong>
+          {{ site_name }}
+          <span class="version">
+            {{ config.extra.version }}
+          </span>
+        </strong>
         {% if repo_id %}
           <br>
           {{ repo_id }}

material/manifest.json

@@ -2,6 +2,6 @@
   "assets/images/favicon.ico": "assets/images/favicon-e565ddfa3b.ico",
   "assets/javascripts/application.js": "assets/javascripts/application-997097ee0c.js",
   "assets/javascripts/modernizr.js": "assets/javascripts/modernizr-4ab42b99fd.js",
-  "assets/stylesheets/application.css": "assets/stylesheets/application-20d5debb47.css",
+  "assets/stylesheets/application.css": "assets/stylesheets/application-0dac3e5884.css",
   "assets/stylesheets/palettes.css": "assets/stylesheets/palettes-05ab2406df.css"
 }

mkdocs.yml

@@ -36,7 +36,7 @@ theme_dir: material
 
 # Options
 extra:
-  version: 0.2.1
+  version: 0.2.3
   logo: images/logo.png
   author:
     github: squidfunk

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mkdocs-material",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "A material design theme for MkDocs",
   "homepage": "http://squidfunk.github.io/mkdocs-material/",
   "authors": [

setup.py

@@ -23,7 +23,7 @@ from setuptools import setup, find_packages
 # Package description
 setup(
     name = 'mkdocs-material',
-    version = '0.2.1',
+    version = '0.2.3',
     url = 'http://squidfunk.github.io/mkdocs-material/',
     license = 'MIT',
     description = 'A material design theme for MkDocs',

src/assets/stylesheets/_highlight.scss

@@ -55,10 +55,24 @@ pre {
 /*
  * Types and functions
  */
-.kt, .kd, .n.f {
+.kt, .kd {
   color: #0086B3;
 }
 
+/*
+ * Function definition
+ */
+.nf, .n.f {
+  color: #795da3;
+}
+
+/*
+ * Classes
+ */
+.nx {
+  color: #0086b3;
+}
+
 /*
  * Strings
  */

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

@@ -46,10 +46,29 @@
   /*
    * Headlines, chapters, links and inline code
    */
-  h1, h2, a, code {
+  h1, h2, a {
     color: $primary;
   }
 
+  /*
+   * Inline code
+   */
+  code {
+    background: #eee;
+  }
+
+  /*
+   * Keyboard tags
+   */
+  kbd {
+    color: #555;
+    background-color: #fcfcfc;
+    border: solid 1px #ccc;
+    border-bottom-color: #bbb;
+    border-radius: 3px;
+    box-shadow: inset 0 -1px 0 #bbb;
+  }
+
   /*
    * Lower border for main headline
    */
@@ -93,20 +112,6 @@
     th {
       background: mix($primary, $white, 75%);
       color: $white;
-
-      /*
-       * Round upper left border
-       */
-      &:first-child {
-        border-top-left-radius: 3px;
-      }
-
-      /*
-       * Round upper right border
-       */
-      &:last-child {
-        border-top-right-radius: 3px;
-      }
     }
 
     /*

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

@@ -190,6 +190,16 @@
    */
   p > code {
     white-space: nowrap;
+    padding: 2px 4px;
+  }
+
+  /*
+   * Keyboard tags
+   */
+  kbd {
+    display: inline-block;
+    padding: 3px 5px;
+    line-height: 10px;
   }
 
   /*
@@ -223,6 +233,7 @@
   table {
     margin: 3.0em 0 1.5em;
     font-size: 13px;
+    overflow: hidden;
 
     /*
      * The semi-cool solution, in case javascript is not available

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

@@ -46,7 +46,7 @@ body, input {
 /*
  * Proportional fonts
  */
-pre, code {
+pre, code, kbd {
   font-family: 'Courier New', 'Courier', monospace;
 
   /*

src/base.html

@@ -58,11 +58,11 @@
     {% endif %}
 
     <!-- Favicon -->
-    {% set icon = icon | default("assets/images/favicon.ico") %}
+    {% set favicon = favicon | default("assets/images/favicon.ico") %}
     <link rel="shortcut icon" type="image/x-icon"
-      href="{{ base_url }}/{{ icon }}" />
+      href="{{ base_url }}/{{ favicon }}" />
     <link rel="icon" type="image/x-icon"
-      href="{{ base_url }}/{{ icon }}" />
+      href="{{ base_url }}/{{ favicon }}" />
 
     <!-- Configure icons (placed here to omit issues with subdirectories) -->
     <style>

src/drawer.html

@@ -17,7 +17,12 @@
 
       <!-- Project name and verison -->
       <div class="name">
-        <strong>{{ site_name }} {{ config.extra.version }}</strong>
+        <strong>
+          {{ site_name }}
+          <span class="version">
+            {{ config.extra.version }}
+          </span>
+        </strong>
 
         <!-- Project repository name -->
         {% if repo_id %}