Merge pull request #18 from nielsenramon/nr-update-versions

Update versions + use new html-proofer syntax + add og-image + update README + bump version

README.md

@@ -19,10 +19,6 @@ Setup your environment:
 
     bin/setup
 
-Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file!
-
-*If you do not want the Kickster files but just the deploy then copy the `bin/deploy` script to your repo and your ready to go.*
-
 ## Development
 
 Run Jekyll:
@@ -33,17 +29,21 @@ Used tools:
   - [Autoprefixer](https://github.com/postcss/autoprefixer)
   - [Bower](http://bower.io/)
   - [Circle CI](https://circleci.com/)
+  - [Html-proofer](https://github.com/gjtorikian/html-proofer)
   - [Jekyll](http://jekyllrb.com/)
   - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
+  - [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
   - [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
 
-## Manual deploy to GitHub Pages
+*If you do not want the Kickster setup but just the deploy scripts then copy them from the `bin` folder.*
+
+## Deploy to GitHub Pages
 
 Run this in the root project folder in your console:
 
     bin/deploy
 
-That's it, enjoy your nicely build project on GitHub pages!
+*Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file!*
 
 ## Automated deployment with Circle CI
 
@@ -53,7 +53,7 @@ Automated deployment is by default not included in your Kickster generated Jekyl
 
 #### 1. Copy the required automated deploy script
 
-Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/circle/automated) script inside the `/bin` folder of your project (check if the file has execute permissions!).
+Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/circle/automated) script inside the `/bin` folder of your project (make sure the file has execute permissions!).
 
 #### 2. Update `circle.yml`
 
@@ -64,14 +64,20 @@ Replace your `circle.yml` file with [this](https://github.com/nielsenramon/kicks
 
 #### 3. Enable Circle CI.
 
-Make sure you enable your repository in Circle CI. In Circle CI go to `Project settings > Checkout SSH Keys` and create a new User key. This is required to push to the GitHub repo from a script (permissions).
+Make sure you enabled your repository on Circle CI. In Circle CI go to `Project settings > Checkout SSH Keys` and create a new User key. This is required to push to the GitHub repo from a script (permissions).
 
 <img src="https://dl.dropboxusercontent.com/u/20823269/kickster-circle.jpg" alt="Screenshot of user key creating in Circle CI">
 
 That's it, start pushing changes and enjoy your automated deployments from now on!
 
 _Want to use Travis CI? [Click here](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) to view all info on how to setup._
 
+## Support
+
+Need help with setting up Kickster? Join me on [Gitter](https://gitter.im/nielsenramon/kickster) and I help you out.
+
+If you found a bug please report it in [GitHub issues](https://github.com/nielsenramon/kickster/issues).
+
 ## License
 
 MIT License

circle.yml

@@ -1,6 +1,6 @@
 machine:
   ruby:
-    version: 2.3.0
+    version: 2.3.1
 
 dependencies:
   pre:
@@ -13,4 +13,4 @@ test:
     - ls -al
     - cd test && bin/setup
     - cd test && bundle exec jekyll build
-    - cd test && bundle exec htmlproof ./_site --only-4xx --href-ignore "#"
+    - cd test && bundle exec htmlproofer ./_site --only-4xx --allow-hash-href

lib/kickster/version.rb

@@ -1,3 +1,3 @@
 module Kickster
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

snippets/circle/circle.yml

@@ -3,7 +3,7 @@ machine:
     USER_NAME: <your-github-username>
     USER_EMAIL: <your-github-email>
   ruby:
-    version: 2.2.3
+    version: 2.3.1
 
 dependencies:
   pre:
@@ -12,7 +12,7 @@ dependencies:
 test:
   post:
     - bundle exec jekyll build
-    - bundle exec htmlproof ./_site --only-4xx --href-ignore "#"
+    - bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
 
 deployment:
   production:

snippets/travis/.travis.yml

@@ -1,11 +1,11 @@
 language: ruby
 rvm:
-- 2.2.3
+- 2.3.1
 install:
 - ./bin/setup
 script:
 - bundle exec jekyll build --trace
-- bundle exec htmlproof ./_site --only-4xx
+- bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
 after_success:
 - test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && "./bin/automated"
 env:

snippets/travis/README.md

@@ -11,11 +11,11 @@ Automated deployment is by default not included in your Kickster generated Jekyl
 
 #### 1. Copy the required automated deploy script
 
-Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/automated) script inside the `/bin` folder of your project (check if the file has execute permissions!).
+Copy the [automated](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/automated) script inside the `/bin` folder of your project (make sure the file has execute permissions!).
 
 #### 2. Add `.travis.yml`
 
-Copy the `.travis.yml` from the [snippets](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/.travis.yml) folder inside the `/bin` folder of your project(check if the file has execute permissions!).
+Copy the `.travis.yml` from the [snippets](https://github.com/nielsenramon/kickster/blob/master/snippets/travis/.travis.yml) folder inside the `/bin` folder of your project(make sure the file has execute permissions!).
 
 And adjust the following 2 lines with your information:
 
@@ -33,14 +33,14 @@ First give it a proper name so it is easy to recognize later. Then check `repo`
 
 Copy the generated token.
 
-*Don't forget to enable your repository in [Travis CI](https://travis-ci.org/)*
+*Don't forget to enable your repository in [Travis CI](https://travis-ci.org/).*
 
 Go back to your project in terminal and input the following:
 
     gem install travis
     travis encrypt GITHUB_TOKEN=secret-token-from-github --add
 
-This added a line inside your `.travis.yml' file like this:
+This added a line inside your `.travis.yml` file like this:
 
     secure: <encrypted token>
 

template/.ruby-version

@@ -1 +1 @@
-2.3.0
+2.3.1

template/Gemfile

@@ -1,9 +1,9 @@
 source "https://rubygems.org"
 
-gem "autoprefixer-rails", "~> 6.3.1"
-gem "html-proofer", "~> 2.6.4"
-gem "jekyll", "~> 3.1.1"
-gem "jekyll-assets", "~> 2.1.2"
-gem "jekyll-sitemap", "~> 0.10.0"
-gem "sass", "~> 3.4.21"
-gem "uglifier", "~> 2.7.2"
+gem "autoprefixer-rails"
+gem "html-proofer"
+gem "jekyll"
+gem "jekyll-assets"
+gem "jekyll-sitemap"
+gem "sass"
+gem "uglifier"

template/README.md.tt

@@ -13,14 +13,19 @@ Run Jekyll:
     bundle exec jekyll serve --watch
 
 Used tools:
-  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
+  - [Autoprefixer](https://github.com/postcss/autoprefixer)
   - [Bower](http://bower.io/)
+  - [Circle CI](https://circleci.com/)
+  - [Html-proofer](https://github.com/gjtorikian/html-proofer)
   - [Jekyll](http://jekyllrb.com/)
-  - Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
-  - [Autoprefixer](https://github.com/postcss/autoprefixer)
+  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
+  - [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
+  - [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
 
 ## Deploy to GitHub Pages
 
 Run this in the root project folder in your console:
 
     bin/deploy
+
+[View this](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci) for more info about automated deployment with Circle CI.

template/_layouts/default.html

@@ -11,13 +11,13 @@
   <meta property="og:url" content="{{ site.url }}">
   <meta property="og:description" content="{{ page.description }}">
   <meta property="og:site_name" content="{{ site.name }}">
-  <meta property="og:image" content="">
+  <meta property="og:image" content="{% asset_path og-image.jpg %}">
 
   <meta name="twitter:card" content="summary">
   <meta name="twitter:url" content="{{ site.url }}">
   <meta name="twitter:title" content="{{ page.title }}">
   <meta name="twitter:description" content="{{ page.description }}">
-  <meta name="twitter:image" content="">
+  <meta name="twitter:image" content="{% asset_path og-image.jpg %}">
 
   <link rel="apple-touch-icon" href="{% asset_path apple-touch-icon.png %}">
 
@@ -38,12 +38,8 @@
   {% javascript application %}
 
   <script>
-    (function(b,o,i,l,e,r){b.GoogleAnalyticsObject=l;b[l]||(b[l]=
-    function(){(b[l].q=b[l].q||[]).push(arguments)});b[l].l=+new Date;
-    e=o.createElement(i);r=o.getElementsByTagName(i)[0];
-    e.src='https://www.google-analytics.com/analytics.js';
-    r.parentNode.insertBefore(e,r)}(window,document,'script','ga'));
-    ga('create','{{ site.ga_analytics }}','auto');ga('send','pageview');
+    window.ga=function(){ga.q.push(arguments)};ga.q=[];ga.l=+new Date;
+    ga('create','{{ site.ga_analytics }}','auto');ga('send','pageview')
   </script>
 </body>
 </html>

template/bin/setup

@@ -9,6 +9,7 @@ set -e
 # Set up Ruby dependencies via Bundler.
 gem install bundler --conservative
 bundle check || bundle install
+bundle update
 
 # Set up JS dependencies via Bower.
 bower --version > /dev/null || npm install -g bower

template/bower.json.tt

@@ -1,6 +1,6 @@
 {
   "name": "<%= snake_name %>",
   "dependencies": {
-    "jquery": "~1.12.0"
+    "jquery": "~2.2.3"
   }
 }

template/circle.yml

@@ -1,6 +1,6 @@
 machine:
   ruby:
-    version: 2.3.0
+    version: 2.3.1
 
 dependencies:
   pre:
@@ -9,4 +9,4 @@ dependencies:
 test:
   post:
     - bundle exec jekyll build
-    - bundle exec htmlproof ./_site --only-4xx --href-ignore "#"
+    - bundle exec htmlproofer ./_site --only-4xx --allow-hash-href