Add pixyll.gemspec

Author: ashawley

.gitignore

@@ -7,3 +7,4 @@ _site
 _config.gh-pages.yml
 
 Gemfile.lock
+*.gem

.travis.yml

@@ -6,7 +6,16 @@ rvm:
  - 2.4
  - 2.5
  - 2.6
+env:
+ - JEKYLL_VERSION: "~> 3.4.5"
+ - JEKYLL_VERSION: "~> 3.5.2"
+ - JEKYLL_VERSION: "~> 3.6.3"
+ - JEKYLL_VERSION: "~> 3.7.4"
+ - JEKYLL_VERSION: "~> 3.8"
+before_install:
+ - gem install --no-document -v "${JEKYLL_VERSION}" jekyll
 script:
+ - bundle exec jekyll --version
  - bundle exec jekyll build
  - rake 'draft[Hello\, world]'
  - rake undraft[hello-world.md]
@@ -15,3 +24,17 @@ script:
  - grep pagination-item    _site/index.html
  - grep johnotander/pixyll _site/css/pixyll.css
  - grep 404                _site/404.html
+ - gem build pixyll.gemspec
+ - bundle exec jekyll new pixyll-example
+ - cd pixyll-example
+ - bundle install
+ - mv index.md index.html
+ - "sed -i~ -e 's/layout: home/layout: default/'           index.html"
+ - "echo paginate: 1 >> _config.yml"
+ - "sed -i~ -e 's/minima/pixyll/'                          _config.yml"
+ - "sed -i~ -e '/^gems:/a\\\n\\ \\ -\\ jekyll-paginate\n'    _config.yml"
+ - "sed -i~ -e '/^plugins:/a\\\n\\ \\ -\\ jekyll-paginate\n' _config.yml"
+ - "sed -i~ -e 's/minima/pixyll/'                          Gemfile"
+ - "sed -i~ -e '/the default theme/d'                      Gemfile"
+ - bundle exec jekyll build
+ - grep pixyll          _site/index.html

Gemfile

@@ -1,6 +1,3 @@
 source 'https://rubygems.org'
-
-# A simple Ruby Gem to bootstrap dependencies for setting up and
-# maintaining a local Jekyll environment in sync with GitHub Pages
-# https://github.com/github/pages-gem
+gemspec
 gem 'github-pages'

README.md

@@ -18,12 +18,29 @@ This Jekyll theme was crafted with <3 by [John Otander](http://johnotander.com)
 If you're completely new to Jekyll, I recommend checking out the documentation at <http://jekyllrb.com> or there's a tutorial by [Smashing Magazine](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/).
 
 ```
-$ git clone [email protected]:johnotander/pixyll.git
+$ git clone -o upstream [email protected]:johnotander/pixyll.git
 $ cd pixyll
 $ gem install bundler # If you don't have bundler installed
 $ bundle install
 ```
 
+Alternatively, if want to install the theme as a Gem, you can add this
+line to your Gemfile:
+
+```ruby
+gem "pixyll"
+```
+
+Then, add this line to your Jekyll site:
+
+```yaml
+theme: pixyll
+```
+
+And then execute:
+
+    $ bundle install
+
 #### Verify your Jekyll version
 
 It's important to also check your version of Jekyll since this project uses new `baseurl` features that are [only supported in 3.3+](https://jekyllrb.com/news/2016/10/06/jekyll-3-3-is-here/).
@@ -32,6 +49,13 @@ It's important to also check your version of Jekyll since this project uses new
 
 Fork the repo, and then clone it so you've got the code locally.
 
+If `git remote -v` doesn't have your fork listed, you can do the following to add it:
+
+```
+git remote add origin [email protected]:USER/pixyll.git
+```
+
+Where `USER` above is your GitHub user name.
 
 ### Modify the `_config.yml`
 
@@ -67,6 +91,21 @@ Now you can navigate to `localhost:4000` in your browser to see the site.
 
 You can host your Jekyll site for free with Github Pages. [Click here](https://pages.github.com/) for more information.
 
+If you are using the gem (see above), then you need to add the the
+github-pages gem to your Gemfile:
+
+```ruby
+gem 'github-pages'
+```
+
+Alternatively, you can enable Pixyll on Githug Pages using the `remote_theme` feature, by adding this line to your `_config.yml`:
+
+```yml
+remote_theme: johno/pixyll
+```
+
+See [Adding a Jekyll theme to your GitHub pages](https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site).
+
 #### A configuration tweak if you're using a gh-pages sub-folder
 
 In addition to your github-username.github.io repo that maps to the root url, you can serve up sites by using a gh-pages branch for other repos so they're available at github-username.github.io/repo-name.

_config.yml

@@ -126,3 +126,5 @@ exclude:
   - Gemfile
   - Gemfile.lock
   - vendor
+  - pixyll.gemspec
+  - '*.gem'

appveyor.yml

@@ -1,14 +1,27 @@
 # appveyor.yml
 
 environment:
-  RUBY_VERSION: 25
+  matrix:
+  - RUBY_VERSION: 24
+    JEKYLL_VERSION: "~> 3.5.2"
+  - RUBY_VERSION: 24
+    JEKYLL_VERSION: "~> 3.6.3"
+  - RUBY_VERSION: 25
+    JEKYLL_VERSION: "~> 3.6.3"
+  - RUBY_VERSION: 25
+    JEKYLL_VERSION: "~> 3.7.4"
+  - RUBY_VERSION: 26
+    JEKYLL_VERSION: "~> 3.7.4"
+  - RUBY_VERSION: 26
+    JEKYLL_VERSION: "~> 3.8"
 
 platform:
   - x64
 
 install:
   - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
   - bundle install
+  - gem install --no-document -v "%JEKYLL_VERSION%" jekyll
 
 before_build:
   - ruby -v
@@ -21,3 +34,4 @@ build_script:
   - bundle exec jekyll build
   - rake 'draft[Hello\, world]'
   - rake undraft[hello-world.md]
+  - gem build pixyll.gemspec

pixyll.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "pixyll"
+  spec.version       = "3.0.0"
+  spec.authors       = ["John Otander"]
+  spec.email         = ["[email protected]"]
+
+  spec.summary       = %q{A simple, beautiful Jekyll theme that's mobile first.}
+  spec.homepage      = "http://pixyll.com"
+  spec.license       = "MIT"
+
+  spec.metadata["plugin_type"] = "theme"
+
+  spec.files         = `git ls-files -z`.split("\x0").select do |f|
+    f.match(%r{^((_includes|_layouts|_sass|css)/|Rakefile|(LICENSE|README)((\.(txt|md|markdown)|$)))}i)
+  end
+
+  spec.add_runtime_dependency "jekyll", "~> 3.3"
+  spec.add_runtime_dependency "jekyll-paginate", "~> 1.1"
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+end