jekyll-theme-lanyon 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 238a382f0591202dfc4dc78f938d35dc0d9aa197
-  data.tar.gz: 6607761056d2d785e7b7d742eb14b9349a45233e
+SHA256:
+  metadata.gz: 199a8aa3edb870a0139fbbdf95c8f511da484c09fd9a5662658747075529a812
+  data.tar.gz: abc4a11b6d3331625c39c593241124b7a9d2f30d71df39891c46c5725a5742d4
 SHA512:
-  metadata.gz: e1c67c3b7eb99efdc7a36147016579abca0ece196f35c577d9a68d05e61a605a7e0543a4f02637d78e3105bde001091e1f48aa7286de1e67a217464e41a5f2ea
-  data.tar.gz: bf733c71598bb260549d613c905210ba0370069249b0e246149296eb8d080d129aa6757f7d75f78e68ad5f1019eb26a43ac10c0ee454096ac03617597194c50a
+  metadata.gz: 9e7db8efe0f488daebb6f4fa40bd4e78fb906bb396533605e48bf49bee6a4ae6da31f96665954fc26c4ae6a297a4b2e7755df71e6ece30e01ac3f5602d44d0ee
+  data.tar.gz: 4f057dca455f832d0ba7e20dc1113d9c2ab908838c7614a47d0099f762216b6c27eca7a4d7f0fddb6d857675c4bf2565633da77bed53f42d446c4a225dc9d9e1

data/LICENSE.md

@@ -1,9 +1,9 @@
 # Released under MIT License
 
-Copyright (c) 2014 Mark Otto.
+Copyright (c) 2014-present Mark Otto and contributors.
 
 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 NONINFRINGEMENT. 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.
+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 NONINFRINGEMENT. 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.

data/README.md

@@ -9,7 +9,7 @@ Lanyon is an unassuming [Jekyll](http://jekyllrb.com) theme that places content
 ## Contents
 
 - [Usage](#usage)
-  - [Install as a gem](#install-as-a-gem)
+  - [Install as a gem](#install-as-a-gem-based-theme)
 - [Options](#options)
   - [Sidebar menu](#sidebar-menu)
   - [Themes](#themes)
@@ -23,30 +23,72 @@ Lanyon is an unassuming [Jekyll](http://jekyllrb.com) theme that places content
 
 Lanyon is a theme built on top of [Poole](https://github.com/poole/poole), which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See [the Poole usage guidelines](https://github.com/poole/poole#usage) for how to install and use Jekyll.
 
+## Install as a gem-based theme
 
-### Install as a gem
+Jekyll encourage the use of `bundler` to manage themes and plugins. [Themes](https://jekyllrb.com/docs/themes/) can be packaged as Ruby gems since Jekyll 3.3. If you don't intend to modify the theme a lot, this is a nice way of focusing on your content and benefits from  theme updates.
 
-*Note*: Require Jekyll ~> 3.3
+### 1. Install theme
 
-Add this line to your Jekyll site's Gemfile:
+1. Create a folder that will be your Jekyll source directory, e.g `blog`.
+2. Create a `Gemfile` in your source directory to list all theme dependencies, it should looks like this:
 
 ```ruby
-gem "lanyon-theme"
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 3.7.0"
+gem "jekyll-theme-lanyon", "~> 1.1"
 ```
 
-And add this line to your Jekyll site:
+### 2. Configuration
+
+1. Run `bundle install` to install all theme dependencies.
+2. Copy [`_config.yml`](example/_config.yml), [`index.html`](example/index.html), [`404.html`](example/404.html) (and [`about.md`](example/about.md)) from this repository's [example files](example) to your source directory.
+3. Run `bundle exec jekyll serve --livereload` to preview your website locally.
 
-```yaml
-theme: lanyon-theme
+If you list the files in your source directory, don't be surprised if you only see:
+
+```
+├── _posts        # your posts are here
+├── _site         # default destination build directory
+├── _config.yml   # jekyll configuration
+├── 404.html      # default 404 page template
+├── about.md      # default example page
+├── Gemfile       # bundler configuration
+├── Gemfile.lock  # bundler version lock
+└── index.html    # list all the posts on the homepage
 ```
 
-And then execute:
+:bulb: When you use gem-based themes, the themes files don't appear in your source directory, they're packaged within the gem.
+
+If you wonder where the original theme files are, `bundler` allows you to show a gem content:
 
 ```sh
-    $ bundle
+tree $(bundle show jekyll-theme-lanyon)
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE.md
+├── README.md
+├── _includes
+│   ├── head.html
+│   └── sidebar.html
+├── _layouts
+│   ├── default.html
+│   ├── home.html
+│   ├── page.html
+│   └── post.html
+├── assets
+│   ├── apple-touch-icon-precomposed.png
+│   ├── css
+│   │   ├── lanyon.css
+│   │   ├── poole.css
+│   │   └── syntax.css
+│   └── favicon.ico
 ```
 
-To test this theme: run `bundle install` in the `example` folder, then run `bundle exec jekyll serve` and open `http://127.0.0.1:4000/` in your browser.
+If you want to customize the theme, you'll have to copy the files you need to modify in your source directory.
+Report to jekyll's documentation to learn [how to override a theme](https://jekyllrb.com/docs/themes/#overriding-theme-defaults).
 
 ## Options
 

data/_includes/head.html

@@ -15,9 +15,7 @@
   </title>
 
   <!-- CSS -->
-  <link rel="stylesheet" href={{ "/assets/css/poole.css" | relative_url }}>
-  <link rel="stylesheet" href={{ "/assets/css/syntax.css" | relative_url }}>
-  <link rel="stylesheet" href={{ "/assets/css/lanyon.css" | relative_url }}>
+  <link rel="stylesheet" href={{ "/assets/css/styles.css" | relative_url }}>
   <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=PT+Serif:400,400italic,700%7CPT+Sans:400">
 
   <!-- Icons -->

data/{assets/css/lanyon.css → _sass/_lanyon.scss}

@@ -34,7 +34,7 @@
  * Update the foundational and global aspects of the page.
  */
 
-/* Prevent scroll on narrow devices */
+// Prevent scroll on narrow devices
 html,
 body {
   overflow-x: hidden;

data/assets/css/styles.scss

@@ -0,0 +1,8 @@
+---
+# Use a comment to ensure Jekyll reads the file to be transformed into CSS later
+# only main files contain this front matter, not partials.
+---
+
+ @import "poole";
+ @import "syntax";
+ @import "lanyon";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-lanyon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mark Otto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: jekyll-feed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll-sitemap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,10 +109,11 @@ files:
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html
+- _sass/_lanyon.scss
+- _sass/_poole.scss
+- _sass/_syntax.scss
 - assets/apple-touch-icon-precomposed.png
-- assets/css/lanyon.css
-- assets/css/poole.css
-- assets/css/syntax.css
+- assets/css/styles.scss
 - assets/favicon.ico
 homepage: https://github.com/poole/lanyon
 licenses:
@@ -93,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A reserved Jekyll theme that places the utmost gravity on content with a