jekyll-readthedocs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05ba502e95118927158eea5430003fcd64c21dbc
-  data.tar.gz: 8a8825c2bd93e22e04f62dba13ad9f08e77c9075
+  metadata.gz: 9f90ee37365aab92331d4e7493d974ab636c71b1
+  data.tar.gz: 646592101a0fec1c4f5e912535a46d4f8fa2dfd8
 SHA512:
-  metadata.gz: 60a521031e5d6887faf4ab24273eebe77633d12ef334f650f9bf158391ab71a7a3eed42f51f8ed2f2cdc74c564e28c13eb4384919ff6416c8818cc9554efb352
-  data.tar.gz: 17d0637582f1160f5323620fdb3055817f2f2e153df507f697f28fb9169f1e446cdd94882406343a8dada363469401976bc5647ab6db36bcda433b2f12f2d74e
+  metadata.gz: 1bfab6e78cfe8291d1e9b4bcd9797c87fb27d4cd2ad94567769a0e73526f9b56e5e03f9e5c1f97f8391ed94dbcf16b7c4956335d7735f787846507aa6d127a5b
+  data.tar.gz: 3ffe1935869b6cf13092af98b2d0dee7bbffc672f67f6aa0db03ae2cdfe7f83a5484eee1565bf778c718296b95a0cce2fbc4a08b190bf7b36eb53a0a5af6d7b8

data/README.md

@@ -2,9 +2,9 @@
 
 *Jekyll-ReadTheDocs is a fork of Jekyll's Minima base theme. Documentation below may refer to minima instead of this fork.*
 
-[Theme preview](https://jekyll.github.io/minima/)
+[Theme preview](http://pawamoy.github.io/) (my own blog using this theme).
 
-![readthedocs theme preview](/screenshot.png)
+![jekyll readthedocs theme preview](/screenshot.png)
 
 ## Installation
 
@@ -25,6 +25,21 @@ And then execute:
     $ bundle
 
 
+### With GitHub Pages
+To use this theme with GitHub Pages, you might need to declare the theme as remote in your `_config.yml` file:
+
+```yaml
+#theme: jekyll-readthedocs
+remote_theme: pawamoy/jekyll-readthedocs
+```
+
+And your `Gemfile` should be:
+
+```ruby
+source "https://rubygems.org"
+gem 'github-pages', group: :jekyll_plugins
+```
+
 ### Layouts
 
 Refers to files within the `_layouts` directory, that define the markup for your theme.
@@ -84,6 +99,8 @@ It will be automatically included only when your site contains one or more valid
 
 The title for this section is `Posts` by default and rendered with an `<h2>` tag. You can customize this heading by defining a `list_title` variable in the document's front matter.
 
+To add post excerpts in the post listing, set `use_excerpt: true` in `_config.yml`. 
+
 --
 
 ### Customization

data/_includes/sidebar.html

@@ -1,8 +1,9 @@
 <div class="site-sidebar">
   <a class="sidebar-title" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
 
-  <input type=text placeholder="Search blog">
-  <br>
+  <form method="get" action="{{ site.baseurl }}/search.html">
+    <input type="text" name="q" placeholder="Search blog">
+  </form>
 
   {% assign default_paths = site.pages | map: "path" %}
   {% assign page_paths = site.header_pages | default: default_paths %}
@@ -23,7 +24,7 @@
         {% for path in page_paths %}
           {% assign my_page = site.pages | where: "path", path | first %}
           {% if my_page.title %}
-            <li><a href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a></li>
+            <li {% if page.title == my_page.title %}class="active"{% endif %}><a href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a></li>
           {% endif %}
         {% endfor %}
       </ul>
@@ -33,7 +34,7 @@
   {% if site.posts.size > 0 %}
     <ul>
       {% for post in site.posts %}
-        <li>
+        <li {% if page.title == post.title %}class="active"{% endif %}>
           {% assign date_format = site.minima.date_format | default: "%b %-d, %Y" %}
           <span>{{ post.date | date: date_format }}</span><br>
           <a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>

data/_layouts/home.html

@@ -10,7 +10,7 @@ layout: default
   {{ content }}
 
   {% if site.posts.size > 0 %}
-  <h2 class="post-list-heading">{{ page.list_title | default: "Posts" }}</h2>
+    <h2 class="post-list-heading">{{ page.list_title | default: "" }}</h2>
     <ul class="post-list">
       {% for post in site.posts %}
         <li>
@@ -20,6 +20,7 @@ layout: default
           <h3>
             <a class="post-link" href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
           </h3>
+          {% if site.use_excerpt %}{{ post.excerpt }}{% endif %}
         </li>
       {% endfor %}
     </ul>

data/_sass/minima/_layout.scss

@@ -311,7 +311,6 @@
   }
 
   ul li {
-    list-style: none;
     line-height: 16px;
     padding: 5px 15px;
   }
@@ -324,7 +323,6 @@
     font-size: 70%;
     font-style: italic;
     color: #b3b3b3;
-    list-style: none;
     text-decoration: none;
   }
 
@@ -333,8 +331,21 @@
     position: relative;
     font-size: 90%;
     color: #b3b3b3;
-    list-style: none;
     text-decoration: none;
     cursor: pointer;
   }
+
+  ul li.active {
+    background-color: $background-color;
+    font-weight: bold;
+
+    span, a {
+      color: $text-color;
+    }
+
+    // a {
+    //   pointer-events: none;
+    //   cursor: default;
+    // }
+  }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-readthedocs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Timothée Mazzucotelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll