Disqus Comments

to the Disqus shortname you just setup. By default comments appear on all post and pages if you assigned a shortname. To disable commenting on a post or page, add the following to its YAML Front Matter:

comments:false

Social Share Links

To disable Facebook, Twitter, and Google+ share links on a post or page, add the following to its front matter:

share:false

Owner/Author Information

Change your name, and avatar photo (200x200 pixels or larger), email, and social networking URLs. If you want to link to an external image on Gravatar or something similar you’ll need to edit the path in

Adding New Content with Octopress

While completely optional, I’ve included Octopress and some starter templates to automate the creation of new posts and pages. To take advantage of it start by installing the Octopress gem if it isn’t already.

$ gem install octopress

New Post

Default command

$ octopress new post "Post Title"

Default works great if you want all your posts in one directory, but if you’re like me and want to group them into subfolders like

1

/posts

,

1

/portfolio

, etc. Then this is the command for you. By specifying the DIR it will create a new post in that folder and populate the

1

categories:

YAML with the same value.

$ octopress new post "New Portfolio Post Title"--dir portfolio

New Page

To create a new page use the following command.

$ octopress new page new-page/

Jekyll _includes

For the most part you can leave these as is since the author/owner details are pulled from

1

_config.yml

. That said you’ll probably want to customize the copyright stuff in

1

footer.html

to your liking.

Reading Time

On by default. To turn off remove

1

reading_time

from

1

_config.yml

. Default words per minute is set at 200 and can changed by updating

1

words_per_minute

in

1

_config.yml

.

Feature Images

A good rule of thumb is to keep feature images nice and wide so you don’t push the body text too far down. An image cropped around around 1024 x 256 pixels will keep file size down with an acceptable resolution for most devices. If you want to serve these images responsively I’d suggest looking at the Jekyll Picture Tag2 plugin.

The two layouts make the assumption that the feature images live in the images folder. To add a feature image to a post or page just include the filename in the front matter like so.

image:feature:feature-image-filename.jpgthumb:thumbnail-image.jpg#keep it square 200x200 px is good

If you want to apply attribution to a feature image use the following YAML front matter on posts or pages. Image credits appear directly below the feature image with a link back to the original source.

image:feature:feature-image-filename.jpgcredit:Michael Rose#name of the person or site you want to creditcreditlink:http://mademistakes.com#url to their site or licensing

By default the

1

<div>

containing feature images is set to have a minimum height of 400px with CSS. Anything taller is hidden with an

1

overflow: hidden

declaration. You can customize the height of the homepage feature image and those appearing on posts/pages by modifying the following variables in

to watch for updates in JS files that Grunt will then automatically re-build as you write your code, which will in turn auto-generate your Jekyll site when developing locally.

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 MIT License version 2 or later. So feel free to to modify this theme to suit your needs.

Used to generate absolute URLs in

1

feed.xml

, and for canonical URLs in

1

head.html

. Don’t include a trailing

1

/

in your base url ie: http://mademistakes.com. When developing locally I suggest using http://localhost:4000 or whatever localhost you’re using to properly load all theme stylesheets, scripts, and image assets. If you leave this variable blank all links will resolve correctly except those pointing to home. ↩

If you’re using GitHub Pages to host your site be aware that plugins are disabled. So you’ll need to build your site locally and then manually deploy if you want to use this sweet plugin. ↩