Go to file
Bradlee Speice 3e130e2572 Fix the footnote references 2015-02-24 20:34:00 -05:00
_includes Upgrade Google analytics to Google universal analytics 2014-04-18 14:33:20 +03:00
_layouts Remove links on image credits with no creditlink 2014-03-19 09:52:41 +01:00
_posts Fix the footnote references 2015-02-24 20:34:00 -05:00
assets Improve menu scrolling on small screens 2014-02-26 15:20:30 -05:00
images Compile uncompressed stylesheet along .min for easier updating for non-Less users 2014-02-25 16:00:54 -05:00
.gitignore Fix a broken tag 2014-11-09 21:03:54 -05:00
.jshintrc Add Grunt build script 2013-08-24 17:13:07 -04:00
404.md Engage! 2013-08-23 15:06:39 -04:00
Gemfile Revise installation instructions 2014-02-12 09:30:09 -05:00
Gruntfile.js Compile uncompressed stylesheet along .min for easier updating for non-Less users 2014-02-25 16:00:54 -05:00
LICENSE Engage! 2013-08-23 15:06:39 -04:00
README.md change archive.html to posts.html 2014-04-21 22:21:24 -04:00
Rakefile.rb Add new post/page rake task 2014-02-10 15:41:26 -05:00
_config.yml Add Disqus to the blog 2015-01-13 18:55:28 -05:00
about.md Document background image feature 2013-10-26 20:07:11 -04:00
favicon.ico Engage! 2013-08-23 15:06:39 -04:00
favicon.png Engage! 2013-08-23 15:06:39 -04:00
feed.xml Validate feed 2014-01-11 16:54:02 -05:00
index.html Remove schema.org reference to simplify markup 2014-01-15 14:53:10 -05:00
package.json Add Grunt build script 2013-08-24 17:13:07 -04:00
posts.html Group all posts by year 2014-02-26 15:48:56 -05:00
sitemap.xml Add pages to sitemap 2014-02-17 08:21:57 -05:00
tags.html Group all posts by year 2014-02-26 15:48:56 -05:00

README.md

HPSTR Jekyll Theme

They say three times the charm, so here is another free responsive Jekyll theme for you. I've learned a ton since open sourcing my first two themes on Github, and wanted to try a few new things this time around. If you've used my previous themes most of this should be familiar territory...

What HPSTR brings to the table:

  • Responsive templates for post, page, and post index _layouts. Looks great on mobile, tablet, and desktop devices.
  • Gracefully degrades in older browsers. Compatible with Internet Explorer 8+ and all modern browsers.
  • Modern and minimal design.
  • Sweet animated menu.
  • Readable typography to make your words shine.
  • Support for large images to call out your favorite posts.
  • Comments powered by Disqus if you choose to enable.
  • Social Sharing links for Facebook, Twitter, and Google+ if you choose to enable.
  • Simple and clear permalink structure.
  • Open Graph and Twitter Cards support for a better social sharing experience.
  • Simple custom 404 page to get you started.
  • Stylesheets for Pygments and Coderay syntax highlighting to make your code examples look snazzy
  • Grunt build script for easy theme development
  • Available in Spanish. Thanks @cruznick!

HPSTR Theme Preview screenshot


General notes and suggestions for customizing HPSTR.

Basic Setup for a new Jekyll site

  1. Install Bundler gem install bundler and then install Jekyll and all dependencies bundle install.
  2. Fork the HPSTR Jekyll Theme repo.
  3. Clone the repo you just forked and rename it.
  4. Edit _config.yml to personalize your site.
  5. Check out the sample posts in _posts to see examples for pulling in large feature images, assigning categories and tags, and other YAML data.
  6. Read the documentation below for further customization pointers and documentation.

Demo the Theme

Pro-tip: Delete the gh-pages branch after cloning and start fresh by branching off master. There is a bunch of garbage in gh-pages used for the theme's demo site that I'm guessing you don't want on your site.


Setup for an Existing Jekyll site

  1. Clone the following folders: _includes, _layouts, assets, and images.
  2. Clone the following files and personalize content as need: about.md, posts.html, index.html, tags.html, and feed.xml.
  3. Set the following variables in your config.yml file:
title:            Site Title
description:      Describe your website here.
disqus_shortname: shortname
# Your site's domain goes here. When working locally use localhost server leave blank
# PS. If you set this wrong stylesheets and scripts won't load and most links will break.
# PPS. If you leave it blank for local testing home links won't work, they'll be fine for live domains though.
url:              http://localhost:4000

# Owner/author information
owner:
  name:           Your Name
  avatar:         avatar.jpg
  bio:            "Your bio goes here. It shouldn't be super long but a good two sentences or two should suffice."
  email:          you@email.com
  # Social networking links used in footer. Update and remove as you like.
  twitter:        
  facebook:       
  github:         
  stackexchange:  
  linkedin:       
  instagram:      
  flickr:         
  tumblr:         
  # For Google Authorship https://plus.google.com/authorship
  google_plus:    

# Analytics and webmaster tools stuff goes here
google_analytics:   
google_verify:      
# https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
bing_verify:         

# Links to include in top navigation
# For external links add external: true
links:
  - title: Theme Setup
    url: /theme-setup
  - title: External Link
    url: http://mademistakes.com
    external: true

# http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
timezone:    America/New_York
future:      true
pygments:    true
markdown:    kramdown

# Amount of posts to show on home page
paginate: 5

More Theme Setup Goodness

To learn more about how to customize the theme, include feature images in posts, use the Grunt build script, and some other junk, read up here.


Questions?

Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter @mmistakes or file a GitHub Issue. And if you make something cool with this theme feel free to let me know.


License

This theme is free and open source software, distributed under the GNU General Public License version 2 or later. So feel free to to modify this theme to suit your needs.