N-archive/hacks-guide-minimal-mistakes-theme

📐 Jekyll theme for building a personal site, blog, project documentation, or portfolio.

Go to file

Michael Rose b9b9154797 Create media query mixins and consolidate .less files		2014-02-13 13:29:42 -05:00
_includes	Create media query mixins and consolidate .less files	2014-02-13 13:29:42 -05:00
_layouts	Rename Articles to Posts to stay consistent with Jekyll naming conventions	2014-01-15 15:32:48 -05:00
_posts	Remove category	2014-02-12 10:57:50 -05:00
assets	Create media query mixins and consolidate .less files	2014-02-13 13:29:42 -05:00
images	Remove table of contents hover indent	2014-02-12 11:00:22 -05:00
.gitignore	Initial commit	2013-05-24 10:25:31 -04:00
.jshintrc	Init Gruntjs build script	2013-09-09 10:12:07 -04:00
404.md	Add custom 404 page	2013-09-07 13:08:00 -04:00
_config.yml	Rename Articles to Posts to stay consistent with Jekyll naming conventions	2014-01-15 15:32:48 -05:00
about.md	Rename Articles to Posts to stay consistent with Jekyll naming conventions	2014-01-15 15:32:48 -05:00
favicon.ico	Minor cleanup	2013-05-24 12:04:43 -04:00
favicon.png	Add favicons and iOS icons	2013-05-28 10:43:55 -04:00
feed.xml	Correct url to jekyll	2014-01-17 10:44:28 +01:00
Gemfile	Update Gemfile	2014-02-12 09:40:24 -05:00
Gruntfile.js	Create media query mixins and consolidate .less files	2014-02-13 13:29:42 -05:00
index.md	Add image attribution for post and page feature images	2013-09-07 09:05:36 -04:00
LICENSE	Update theme setup documentation	2013-09-09 12:20:51 -04:00
package.json	Init Gruntjs build script	2013-09-09 10:12:07 -04:00
posts.md	Rename Articles to Posts to stay consistent with Jekyll naming conventions	2014-01-15 15:32:48 -05:00
Rakefile.rb	Add rake tasks for creating new posts/pages	2014-02-12 10:58:10 -05:00
README.md	Correct demo theme link	2014-02-12 11:06:01 -05:00
sitemap.xml	Initial commit	2013-05-24 10:25:31 -04:00
theme-setup.md	Add rake tasks for creating new posts/pages	2014-02-12 10:58:10 -05:00

README.md

Minimal Mistakes

Minimal Mistakes is a two column responsive Jekyll theme perfect for powering your GitHub hosted blog.

Minimal Mistakes is all about:

Responsive templates. Looking good on mobile, tablet, and desktop.
Gracefully degrading in older browsers. Compatible with Internet Explorer 8+ and all modern browsers.
Minimal embellishments. Content first; other widget nonsense never.
Large feature images for posts and pages.
Simple and clear permalink structure.
Custom 404 page to get you started.
Stylesheets for Pygments and Coderay syntax highlighting to make your code examples look snazzy.

General notes and suggestions for customizing Minimal Mistakes.

Basic Setup for a new Jekyll site

Install Bundler gem install bundler and then install Jekyll and all dependencies bundle install.
Fork the Minimal Mistakes repo.
Clone the repo you just forked and rename it.
Edit _config.yml to personalize your site.
Check out the sample posts in _posts to see examples for pulling in large feature images, assigning categories and tags, and other YAML data.
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

Clone the following folders: _includes, _layouts, assets, and images.
Clone the following files and personalize content as need: about.md, posts.md, index.md, feed.xml, sitemap.xml
Set the following variables in your config.yml file:

title:            Site Title
description:      Describe your website here.
disqus_shortname: shortname
url:              http://your-website.com

# 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

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 use this Jekyll theme on your site without linking back to me or including a disclaimer.