Merge pull request #1 from chrisanthropic/gem

Gemify the theme

Author: chrisanthropic

.bundle/config

@@ -0,0 +1,4 @@
+---
+BUNDLE_PATH: ".vendor"
+BUNDLE_BIN: ".bin"
+BUNDLE_DISABLE_SHARED_GEMS: true

.gitignore

@@ -1,10 +1,12 @@
+starving-artist-jekyll-theme-*.gem
 _site
 .sass-cache
 .asset-cache
 .jekyll-metadata
 
 .bundle
+.bin
+.vendor
 bin
 vendor/ruby
 Gemfile.lock
-notes

Gemfile

@@ -1,10 +1,11 @@
 source "https://rubygems.org"
+#gemspec
 gem 'jekyll'                    #Needed since this is a theme for Jekyll
 gem 'jekyll-feed'
 gem 'rake'                      #Used to simplify building/deploying tasks
 gem 's3_website'                #Used to deploy site to AWS S3
 gem 'mini_magick'               #Used by a raketask to compress/optimize images at build time
-gem 'html_compressor'           #Used to minify our HTML at build time
 gem 'sass'                      
 gem 'image_optim'               #Optimizes our images
 gem 'image_optim_pack'          #Tools that image_optim uses
+gem 'starving-artist-jekyll-theme', github: 'chrisanthropic/starving-artist-jekyll-theme', branch: 'gem'

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 chrisanthropic
+
+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.

LICENSE.txt

@@ -1,10 +1,36 @@
-starving-artist-jekyll-theme
-=============
+# starving-artist-jekyll-theme
 
 Live Demo [HERE](http://chrisanthropic.github.io/starving-artist-jekyll-theme/)
 
 Starving Artist is a simple portfolio theme for visual artists to easily share their work.
 
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem "starving-artist"
+```
+
+And add this line to your Jekyll site:
+
+```yaml
+theme: starving-artist
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Includes the following custom layouts:
+
+- about.html
+- blog.html
+- contact.html
+- gallery.html
+
 ## Basic features include:
 
 * Jekyll 3.0 compatible
@@ -14,8 +40,6 @@ Starving Artist is a simple portfolio theme for visual artists to easily share t
     * Visibility classes
 * Responsive / Mobile-friendly
 * **Javascript free**
-* Custom Rakefile with tasks for deploying, minifying, and notifying search engines about updates
-* image_optim plugin to optimize all images
 * Basic SEO
     * Facebook opengraph integration
     * Twitter card integration
@@ -70,29 +94,9 @@ Uses minimal sass from Zurb Foundation:
 * Populated using Jekyll 'data' nav.yml file
 * Easily customizable text, link, and background colors using the supplied sass variables
 
-### BANNER
-
-
 ### JAVASCRIPT FREE
 The only thing in the theme that uses Javascript is the optional use of google analytics.
 
-### RAKEFILE
-Includes the following custom tasks:
-
-* *minify_html* - uses HTML_compressor to minify HTML
-* *notify* - pings google and bing to notify them about changes to the site/sitemap
-
-These tasks have been bundled into custom build and deploy tasks
-
-* *build* - runs `jekyll build` followed by `minify_html`
-* *deploy* - runs `s3_website push` and then `notify`
-
-### IMAGE_OPTIM PLUGIN
-
-* Custom [image_optim](https://github.com/chrisanthropic/image_optim-jekyll-plugin) plugin will optimize all images in the /images folder and any subdirectories
-  * Uses the original [image_optim](https://github.com/toy/image_optim)
-* Cache file is created on the first run so that only updated/new images are optimized
-
 ### BASIC SEO
 
 * Google Analytics*
@@ -141,17 +145,3 @@ For now it's best to start fresh or install the them and then transfer over any
   * edit the `_data/nav.yml` file as needed
 * Update your social links
   * edit the `_data/socials.yml` file as needed
-
-## Deploying
-I use S3 to host my site and the [s3_website](https://github.com/laurilehmijoki/s3_website) plugin to deploy, if you don't do both of these, delete the `s3_website.yml` file and edit the deploy raketask to fit your needs.
-
-If you plan on using S3 make sure you edit the configs:
-
-* FIRST - add the s3_website.yml file to your gitignore so your credentials don't end up on the web.
-* s3_website.yml
-  * add your `s3_id`. `s3_secret`, and `s3_bucket`
-* Update the Rakefile notify task to use your url
-  * replace `site = "www.YOUR-URL.com"` with your actual url.
-
-## MISC.
-The blog posts included are duplicated from my actual blog and are the documentation of how I created this theme. From starting with a fresh Jekyll installation to the final product.

README.md

@@ -21,52 +21,3 @@ desc "Watch the site and regenerate when it changes"
 task :watch do
   system "JEKYLL_ENV=development bundle exec jekyll serve --config '_config.yml,_config_localhost.yml' --watch"
 end
-
-##############
-#   Deploy   #
-##############
-
-# Deploy the site
-# Ping / Notify after site is deployed
-
-desc "deploy the site"
-task :deploy do
-  system "bundle exec s3_website push"
-  system "bundle exec rake notify" #ping google/bing about our sitemap updates
-end
-
-##############
-#   Notify   #
-##############
-
-# Ping Google and Yahoo to let them know you updated your site
-
-site = "www.YOUR-URL.com"
-
-desc 'Notify Google of the new sitemap'
-task :sitemapgoogle do
-  begin
-    require 'net/http'
-    require 'uri'
-    puts '* Pinging Google about our sitemap'
-    Net::HTTP.get('www.google.com', '/webmasters/tools/ping?sitemap=' + URI.escape('#{site}/sitemap.xml'))
-  rescue LoadError
-    puts '! Could not ping Google about our sitemap, because Net::HTTP or URI could not be found.'
-  end
-end
-
-desc 'Notify Bing of the new sitemap'
-task :sitemapbing do
-  begin
-    require 'net/http'
-    require 'uri'
-    puts '* Pinging Bing about our sitemap'
-    Net::HTTP.get('www.bing.com', '/webmaster/ping.aspx?siteMap=' + URI.escape('#{site}/sitemap.xml'))
-  rescue LoadError
-    puts '! Could not ping Bing about our sitemap, because Net::HTTP or URI could not be found.'
-  end
-end
-
-desc "Notify various services about new content"
-task :notify => [:sitemapgoogle, :sitemapbing] do
-end

Rakefile

@@ -17,14 +17,16 @@ contact_form: "https://formspree.io/ctarwater@chrisanthropic.com"
 
 
 # Exclude our ruby stuff
-exclude: [.bundle, bin, vendor, Gemfile, Gemfile.lock, Rakefile, s3_website.yml]
+exclude: [.bundle, .vendor, .bin, starving-artist.gemspec, bin, vendor, Gemfile, Gemfile.lock, Rakefile, s3_website.yml]
 
 
 # Build settings
 markdown: kramdown
 kramdown:
   input: GFM
 
+theme: starving-artist-jekyll-theme
+  
 # Plugins
 gems:
   - jekyll-feed
@@ -43,25 +45,6 @@ permalink: /blog/:year/:title
 collections:
   - galleries
 
-## Thumbnailer taken from https://github.com/chrisanthropic/jekyll-minimagick
-
-## Autogenerate thumbs for comics
-#mini_magick:
-
-##Create Thumbs for the Archive Page
-#    thumbnail:
-#      source: images/posts/
-#      destination: /images/posts/thumbs
-#      resize: "150x150^"
-#      gravity: "center"
-#      extent: "150x150"
-
-##Autogenerate smaller size for small screens       
-#    small:
-#      source: images/posts/
-#      destination: /images/posts/small
-#      resize: "350"
-
 #### SEO Stuff
 # Google Analytics
 google_universal_analytics: