New docSkimmer version (v0.3.1)

* Update code, documentation, demo to v0.3.1 for compatibility with MkDocs 'Template URL filter addition (2018-07-02)'
hfagerlund · Jul 4, 2018 · d26adf9 · d26adf9
2 parents 628b18e + c6ea364
commit d26adf9
Show file tree

Hide file tree

Showing 25 changed files with 3,344 additions and 3,335 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog:
 
+- - -
+## 0.3.1 - 2018-07-04
+
+#### Changed:
+* Updated [demo](https://hfagerlund.github.io/mkdocs-docskimmer/) (to docSkimmer v0.3.1)
+* Bumped version number
+
+#### Fixed:
+* Compatible with [new MkDocs template URL filter](https://github.com/mkdocs/mkdocs/pull/1526/commits/68e6d1c1f9444ff0fe2a92c1eb76542330d88e4c)
 - - -
 ## 0.3.0 - 2017-06-29
 

diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ Or [download the required version](https://github.com/hfagerlund/mkdocs-docskimm
 
 * Modify the following settings in the 'mkdocs.yml' file:
 
-### For docSkimmer v0.3.0:
+### For docSkimmer v0.3.x:
 ```yaml
 # mkdocs.yml:
 
@@ -49,8 +49,9 @@ theme:
 
 plugins: ['search']
 
+# add theme version number here
 extra:
-    version: 0.3.0
+    version: 0.3.x
 
 ```
 
@@ -109,7 +110,8 @@ theme_dir: 'mkdocs_docskimmer'
 
 | docSkimmer theme version(s) | MkDocs version(s) |
 | :------: | :------: |
-| 0.3.0 | [(current) latest refactor of MkDocs](https://github.com/mkdocs/mkdocs/tree/34ef3ca6d0390959080ce93a695361eea1649272) |
+| 0.3.1 | [Template URL filter addition](https://github.com/mkdocs/mkdocs/tree/decaf6141c90b0123a4b7f03ee839d0780570bc9) |
+| 0.3.0 | [Pages refactor](https://github.com/mkdocs/mkdocs/tree/34ef3ca6d0390959080ce93a695361eea1649272) |
 | 0.2.1 | 0.17.4<br>0.17.3<br>0.17.2<br>0.17.1<br>0.17.0 |
 | 0.2.0 | 0.17.0 |
 | 0.1.1<br>0.1.0 | 0.16.3<br>0.16.2 |

diff --git a/docs/404.html b/docs/404.html
@@ -18,17 +18,17 @@
 
 
     <link rel="shortcut icon" href="/mkdocs-docskimmer/img/favicon.ico">
-	  <link rel="apple-touch-icon" href="/mkdocs-docskimmer/img/apple-touch-icon.png">
-	  <link rel="apple-touch-icon" sizes="72x72" href="/mkdocs-docskimmer/img/apple-touch-icon-72x72.png">
-	  <link rel="apple-touch-icon" sizes="114x114" href="/mkdocs-docskimmer/img/apple-touch-icon-114x114.png">
+	<link rel="apple-touch-icon" href="/mkdocs-docskimmer/img/apple-touch-icon.png">
+	<link rel="apple-touch-icon" sizes="72x72" href="/mkdocs-docskimmer/img/apple-touch-icon-72x72.png">
+	<link rel="apple-touch-icon" sizes="114x114" href="/mkdocs-docskimmer/img/apple-touch-icon-114x114.png">
   </head>
 
   <body>
     <a class="skiptocontent" href="#maincontent" title="Skip to content (when browsing via audio)" accesskey="2" tabindex="1">skip to main content</a>
     <div id="top" class="wrapper">
     <header class="header-main" role="banner">
 
-     <h2 class="header-main__heading"><a class="header-main__link" href="/mkdocs-docskimmer/">docSkimmer theme</a></h2>
+     <h2 class="header-main__heading"><a class="header-main__link" href="/mkdocs-docskimmer/.">docSkimmer theme</a></h2>
 
 </header>
 
@@ -49,7 +49,7 @@ <h2 class="header-main__heading"><a class="header-main__link" href="/mkdocs-docs
 
 
           <li class="nav-main__item" role="menuitem">
-              <a class="nav-main__link" href="/mkdocs-docskimmer/">Intro</a>
+              <a class="nav-main__link" href="/mkdocs-docskimmer/.">Intro</a>
           </li>
 
 
@@ -140,8 +140,8 @@ <h1>404 Page Not Found</h1>
 
   <!--
   MkDocs version : 0.17.2
-  docSkimmer theme version: 0.3.0
-  Build Date UTC : 2018-06-29 21:40:20
+  docSkimmer theme version: 0.3.1
+  Build Date UTC : 2018-07-04 06:46:35
   -->
   </body>
 </html>
diff --git a/docs/css/docskimmer.css b/docs/css/docskimmer.css
@@ -1,5 +1,5 @@
 /*
-   docSkimmer theme v0.3.0
+   docSkimmer theme v0.3.1
    License: BSD-2-Clause license (https://github.com/hfagerlund/mkdocs-docskimmer/blob/master/LICENSE)
 */
 

diff --git a/docs/examples/another-sample-page/index.html b/docs/examples/another-sample-page/index.html
@@ -17,17 +17,17 @@
 
 
     <link rel="shortcut icon" href="../../img/favicon.ico">
-	  <link rel="apple-touch-icon" href="../../img/apple-touch-icon.png">
-	  <link rel="apple-touch-icon" sizes="72x72" href="../../img/apple-touch-icon-72x72.png">
-	  <link rel="apple-touch-icon" sizes="114x114" href="../../img/apple-touch-icon-114x114.png">
+	<link rel="apple-touch-icon" href="../../img/apple-touch-icon.png">
+	<link rel="apple-touch-icon" sizes="72x72" href="../../img/apple-touch-icon-72x72.png">
+	<link rel="apple-touch-icon" sizes="114x114" href="../../img/apple-touch-icon-114x114.png">
   </head>
 
   <body>
     <a class="skiptocontent" href="#maincontent" title="Skip to content (when browsing via audio)" accesskey="2" tabindex="1">skip to main content</a>
     <div id="top" class="wrapper">
     <header class="header-main" role="banner">
 
-     <h2 class="header-main__heading"><a class="header-main__link" href="../../">docSkimmer theme</a></h2>
+     <h2 class="header-main__heading"><a class="header-main__link" href="../..">docSkimmer theme</a></h2>
 
 </header>
 
@@ -49,15 +49,15 @@ <h2 class="header-main__heading"><a class="header-main__link" href="../../">docS
 
 
           <li class="nav-main__item" role="menuitem">
-              <a class="nav-main__link" href="../../">Intro</a>
+              <a class="nav-main__link" href="../..">Intro</a>
           </li>
 
 
 
         <li class="nav-main__item nav-main__item--current" role="menuitem">
 
 
-              <a class="nav-main__link" href="../../examples/sample-page/"> Examples</a>
+              <a class="nav-main__link" href="../sample-page/"> Examples</a>
 
 
 
@@ -96,18 +96,17 @@ <h2 class="header-main__heading"><a class="header-main__link" href="../../">docS
 
 
 
-            <li class="section-toc__item"><a href="../../examples/sample-page/" class="section-toc__link">Sample1</a></li>
+            <li class="section-toc__item"><a href="../sample-page/" class="section-toc__link">Sample1</a></li>
 
 
 
-            <li class="section-toc__item section-toc__item--active"><a href="../../examples/another-sample-page/" class="section-toc__link section-toc__link--active"><span class="visually-hidden">Current: </span> Sample2</a></li>
+            <li class="section-toc__item section-toc__item--active"><a href="./" class="section-toc__link section-toc__link--active"><span class="visually-hidden">Current: </span> Sample2</a></li>
 
 
 
 
 
 </ul>
-
             </aside>
 
 
@@ -468,31 +467,30 @@ <h2 class="page-toc__heading">On this Page:</h2>
 
     <li class="page-toc__item"><a href="../../#another-sample-page" class="page-toc__link" tabindex="0">Another sample page</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#body-copy" class="page-toc__link" tabindex="0">Body copy</a></li>
+        <li class="page-toc__item"><a href="./#body-copy" class="page-toc__link" tabindex="0">Body copy</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#headings" class="page-toc__link" tabindex="0">Headings</a></li>
+        <li class="page-toc__item"><a href="./#headings" class="page-toc__link" tabindex="0">Headings</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#headings-with-secondary-text" class="page-toc__link" tabindex="0">Headings with secondary text</a></li>
+        <li class="page-toc__item"><a href="./#headings-with-secondary-text" class="page-toc__link" tabindex="0">Headings with secondary text</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#blockquotes" class="page-toc__link" tabindex="0">Blockquotes</a></li>
+        <li class="page-toc__item"><a href="./#blockquotes" class="page-toc__link" tabindex="0">Blockquotes</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#lists" class="page-toc__link" tabindex="0">Lists</a></li>
+        <li class="page-toc__item"><a href="./#lists" class="page-toc__link" tabindex="0">Lists</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#code-blocks" class="page-toc__link" tabindex="0">Code blocks</a></li>
+        <li class="page-toc__item"><a href="./#code-blocks" class="page-toc__link" tabindex="0">Code blocks</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#horizontal-rules" class="page-toc__link" tabindex="0">Horizontal rules</a></li>
+        <li class="page-toc__item"><a href="./#horizontal-rules" class="page-toc__link" tabindex="0">Horizontal rules</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/another-sample-page/#data-tables" class="page-toc__link" tabindex="0">Data tables</a></li>
+        <li class="page-toc__item"><a href="./#data-tables" class="page-toc__link" tabindex="0">Data tables</a></li>
 
 
 </ul>
-
      </aside>
 
 
 
 
-      <a href="../../examples/sample-page/" class="maincontent__link maincontent__link--previous-page">Previous: Sample1</a>
+      <a href="../sample-page/" class="maincontent__link maincontent__link--previous-page">Previous: Sample1</a>
 
 
 
@@ -529,8 +527,8 @@ <h2 class="page-toc__heading">On this Page:</h2>
 
   <!--
   MkDocs version : 0.17.2
-  docSkimmer theme version: 0.3.0
-  Build Date UTC : 2018-06-29 21:40:20
+  docSkimmer theme version: 0.3.1
+  Build Date UTC : 2018-07-04 06:46:35
   -->
   </body>
 </html>
diff --git a/docs/examples/sample-page/index.html b/docs/examples/sample-page/index.html
@@ -17,17 +17,17 @@
 
 
     <link rel="shortcut icon" href="../../img/favicon.ico">
-	  <link rel="apple-touch-icon" href="../../img/apple-touch-icon.png">
-	  <link rel="apple-touch-icon" sizes="72x72" href="../../img/apple-touch-icon-72x72.png">
-	  <link rel="apple-touch-icon" sizes="114x114" href="../../img/apple-touch-icon-114x114.png">
+	<link rel="apple-touch-icon" href="../../img/apple-touch-icon.png">
+	<link rel="apple-touch-icon" sizes="72x72" href="../../img/apple-touch-icon-72x72.png">
+	<link rel="apple-touch-icon" sizes="114x114" href="../../img/apple-touch-icon-114x114.png">
   </head>
 
   <body>
     <a class="skiptocontent" href="#maincontent" title="Skip to content (when browsing via audio)" accesskey="2" tabindex="1">skip to main content</a>
     <div id="top" class="wrapper">
     <header class="header-main" role="banner">
 
-     <h2 class="header-main__heading"><a class="header-main__link" href="../../">docSkimmer theme</a></h2>
+     <h2 class="header-main__heading"><a class="header-main__link" href="../..">docSkimmer theme</a></h2>
 
 </header>
 
@@ -49,15 +49,15 @@ <h2 class="header-main__heading"><a class="header-main__link" href="../../">docS
 
 
           <li class="nav-main__item" role="menuitem">
-              <a class="nav-main__link" href="../../">Intro</a>
+              <a class="nav-main__link" href="../..">Intro</a>
           </li>
 
 
 
         <li class="nav-main__item nav-main__item--current" role="menuitem">
 
 
-              <a class="nav-main__link nav-main__link--current" href="../../examples/sample-page/"><span class="visually-hidden">Current: </span>  Examples</a>
+              <a class="nav-main__link nav-main__link--current" href="./"><span class="visually-hidden">Current: </span>  Examples</a>
 
 
 
@@ -94,18 +94,17 @@ <h2 class="header-main__heading"><a class="header-main__link" href="../../">docS
 
 
 
-            <li class="section-toc__item section-toc__item--active"><a href="../../examples/sample-page/" class="section-toc__link section-toc__link--active"><span class="visually-hidden">Current: </span> Sample1</a></li>
+            <li class="section-toc__item section-toc__item--active"><a href="./" class="section-toc__link section-toc__link--active"><span class="visually-hidden">Current: </span> Sample1</a></li>
 
 
 
-            <li class="section-toc__item"><a href="../../examples/another-sample-page/" class="section-toc__link">Sample2</a></li>
+            <li class="section-toc__item"><a href="../another-sample-page/" class="section-toc__link">Sample2</a></li>
 
 
 
 
 
 </ul>
-
             </aside>
 
 
@@ -468,34 +467,33 @@ <h2 class="page-toc__heading">On this Page:</h2>
 
     <li class="page-toc__item"><a href="../../#sample-page" class="page-toc__link" tabindex="0">Sample page</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#body-copy" class="page-toc__link" tabindex="0">Body copy</a></li>
+        <li class="page-toc__item"><a href="./#body-copy" class="page-toc__link" tabindex="0">Body copy</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#headings" class="page-toc__link" tabindex="0">Headings</a></li>
+        <li class="page-toc__item"><a href="./#headings" class="page-toc__link" tabindex="0">Headings</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#headings-with-secondary-text" class="page-toc__link" tabindex="0">Headings with secondary text</a></li>
+        <li class="page-toc__item"><a href="./#headings-with-secondary-text" class="page-toc__link" tabindex="0">Headings with secondary text</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#blockquotes" class="page-toc__link" tabindex="0">Blockquotes</a></li>
+        <li class="page-toc__item"><a href="./#blockquotes" class="page-toc__link" tabindex="0">Blockquotes</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#lists" class="page-toc__link" tabindex="0">Lists</a></li>
+        <li class="page-toc__item"><a href="./#lists" class="page-toc__link" tabindex="0">Lists</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#code-blocks" class="page-toc__link" tabindex="0">Code blocks</a></li>
+        <li class="page-toc__item"><a href="./#code-blocks" class="page-toc__link" tabindex="0">Code blocks</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#horizontal-rules" class="page-toc__link" tabindex="0">Horizontal rules</a></li>
+        <li class="page-toc__item"><a href="./#horizontal-rules" class="page-toc__link" tabindex="0">Horizontal rules</a></li>
 
-        <li class="page-toc__item"><a href="../../examples/sample-page/#data-tables" class="page-toc__link" tabindex="0">Data tables</a></li>
+        <li class="page-toc__item"><a href="./#data-tables" class="page-toc__link" tabindex="0">Data tables</a></li>
 
 
 </ul>
-
      </aside>
 
 
 
 
-      <a href="../../" class="maincontent__link maincontent__link--previous-page">Previous: Intro</a>
+      <a href="../.." class="maincontent__link maincontent__link--previous-page">Previous: Intro</a>
 
 
-      <a href="../../examples/another-sample-page/" class="maincontent__link maincontent__link--next-page">Next: Sample2</a>
+      <a href="../another-sample-page/" class="maincontent__link maincontent__link--next-page">Next: Sample2</a>
 
 
 
@@ -531,8 +529,8 @@ <h2 class="page-toc__heading">On this Page:</h2>
 
   <!--
   MkDocs version : 0.17.2
-  docSkimmer theme version: 0.3.0
-  Build Date UTC : 2018-06-29 21:40:20
+  docSkimmer theme version: 0.3.1
+  Build Date UTC : 2018-07-04 06:46:35
   -->
   </body>
 </html>