hacks-guide-minimal-mistake.../theme-setup.md

220 lines
11 KiB
Markdown
Raw Normal View History

2013-05-24 16:25:31 +02:00
---
layout: page
permalink: /theme-setup/
2013-05-24 16:25:31 +02:00
title: Theme Setup
2013-05-24 20:35:46 +02:00
description: "Instructions on how to install and customize the Jekyll theme Minimal Mistakes."
2013-05-24 16:25:31 +02:00
tags: [Jekyll, theme, responsive]
image:
feature: texture-feature-02.jpg
credit: Texture Lovers
creditlink: http://texturelovers.com
2013-05-24 16:25:31 +02:00
---
2013-05-24 21:06:54 +02:00
<section id="table-of-contents" class="toc">
<header>
<h3 >Contents</h3>
2013-05-24 21:06:54 +02:00
</header>
<div id="drawer" markdown="1">
* Auto generated table of contents
{:toc}
</div>
</section><!-- /#table-of-contents -->
2013-05-24 16:25:31 +02:00
General notes and suggestions for customizing Minimal Mistakes.
## Basic Setup for a new Jekyll site
2013-05-24 16:25:31 +02:00
1. [Install Bundler](http://bundler.io) `gem install bundler` and then install [Jekyll](http://jekyllrb.com) and all dependencies `bundle install`.
2. Fork the [Minimal Mistakes repo](http://github.com/mmistakes/minimal-mistakes/fork).
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.
2013-05-24 16:25:31 +02:00
<div markdown="0"><a href="https://github.com/mmistakes/minimal-mistakes/archive/master.zip" class="btn">Download the Theme</a></div>
**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.
{: .notice}
---
## Folder Structure
2013-05-24 16:25:31 +02:00
2013-05-28 15:00:43 +02:00
{% highlight text %}
2013-05-24 16:25:31 +02:00
minimal-mistakes/
2013-09-09 18:20:51 +02:00
├── _includes/
2013-12-09 15:16:56 +01:00
| ├── _author-bio.html #bio stuff goes here
| ├── _browser-upgrade.html #displays on IE8 and less
| ├── _footer.html #site footer
| ├── _head.html #site head
| ├── _navigation.html #site top nav
| └── _scripts.html #jQuery, plugins, GA, etc.
2013-09-09 18:20:51 +02:00
├── _layouts/
| ├── home.html #homepage layout
| ├── page.html #page layout
| ├── post-index.html #post index layout
2013-09-09 18:20:51 +02:00
| └── post.html #post layout
├── _posts/
├── assets/
| ├── css/ #preprocessed less styles
| ├── fonts/ #icon webfonts
| ├── js/
| | ├── _main.js #Main JavaScript file, plugin settings, etc
| | ├── plugins #jQuery plugins
| | └── vendor/ #jQuery and Modernizr
| └── less/
├── images/ # images for posts and pages
├── about.md # about page
├── posts.md # lists all posts from latest to oldest
2013-09-09 18:20:51 +02:00
└── index.md # homepage. lists 5 most recent posts
2013-05-28 15:00:43 +02:00
{% endhighlight %}
2013-05-24 16:25:31 +02:00
2013-09-09 18:20:51 +02:00
---
2013-05-24 16:25:31 +02:00
## Customization
### _config.yml
2013-09-09 18:20:51 +02:00
Most of the variables found here are used in the .html files found in `_includes` if you need to add or remove anything. A good place to start would be to change the title, tagline, description, and url of your site. When working locally comment out `url` or else you will get a bunch of broken links because they are absolute and prefixed with `{{ "{{ site.url " }}}}`[^1] in the various `_includes` and `_layouts`. Just remember to uncomment `url` when building for deployment or pushing to **gh-pages**...
#### Owner/Author Information
Change your name, bio, and avatar photo (100x100 pixels or larger), Twitter url, email, and Google+ url. If you want to link to an external image on Gravatar or something similiar you'll need to edit the path in `_author-bio.html` since it assumes it is located in `/images`.
2013-09-09 18:20:51 +02:00
Including a link to your Google+ profile has the added benefit of displaying [Google Authorship](https://plus.google.com/authorship) in Google search results if you've went ahead and applied for it. Don't have a Google+ account? Just leave it blank.
#### Google Analytics and Webmaster Tools
Your Google Analytics ID goes here along with meta tags for [Google Webmaster Tools](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=35179) and [Bing Webmaster Tools](https://ssl.bing.com/webmaster/configure/verify/ownershi) site verification.
#### Top Navigation Links
Edit page/post titles and URLs to include in the site's navigation. For external links add `external: true`.
{% highlight yaml %}
# sample top navigation links
links:
- title: About Page
url: /about/
- title: Posts
url: /posts/
- title: Other Page
url: /other-page/
- title: External Page
url: http://mademistakes.com
external: true
{% endhighlight %}
2013-05-24 16:25:31 +02:00
### Adding Posts and Pages
There are two main content layouts: *post.html* (for posts) and *page.html* (for pages). Both have large **feature images** that span the full-width of the screen, and both are meant for long form articles and blog posts.
There are two rake tasks that can be used to create a new post or page with all YAML Front Matter. Using either `rake new_post` or `rake new_page` will prompt you for a title and tags to classify them. Example below:
{% highlight bash %}
rake new_post
Enter a title for your post: My Awesome Post
Enter tags to classify your post (comma separated): web development, code
Creating new post: _posts/2014-02-10-my-awesome-post.md
{% endhighlight %}
There are a few configuration variables that can be changed in `Rakefile.rb`. By default posts and pages will be created in MarkDown using the `.md` extension.
2013-05-24 16:25:31 +02:00
#### Feature Images
2013-09-09 18:20:51 +02:00
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 Tag](https://github.com/scottjehl/picturefill) plugin[^2].
2013-05-24 16:25:31 +02:00
2013-09-09 18:20:51 +02:00
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.
2013-05-24 16:25:31 +02:00
2013-05-28 15:00:43 +02:00
{% highlight yaml %}
2013-05-24 16:25:31 +02:00
image:
feature: feature-image-filename.jpg
thumb: thumbnail-image.jpg #keep it square 200x200 px is good
2013-05-28 15:00:43 +02:00
{% endhighlight %}
2013-05-24 16:25:31 +02:00
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.
{% highlight yaml %}
image:
feature: feature-image-filename.jpg
credit: Michael Rose #name of the person or site you want to credit
creditlink: http://mademistakes.com #url to their site or licensing
{% endhighlight %}
#### Post Index Page
A [sample index page]({{ site.url }}/posts/) listing all posts grouped by the year they were published has been provided. The name can be customized to your liking by editing a few references. For example, to change **Posts** to **Writing** update the following:
* In `_config.yml` under `links:` rename the title and URL to the following:
{% highlight yaml %}
links:
- title: Writing
url: /writing/
{% endhighlight %}
* Rename `posts.md` to `writing.md` and update the YAML front matter to match the title and URL set in `_config.yml`
* Update the **View all posts** link in `post.html` layout found in `_layouts` to match title and URL set previously.
2013-05-24 16:25:31 +02:00
#### Thumbnails for OG and Twitter Cards
2013-12-09 15:16:56 +01:00
Post and page thumbnails work the same way. These are used by [Open Graph](https://developers.facebook.com/docs/opengraph/) and [Twitter Cards](https://dev.twitter.com/docs/cards) meta tags found in *_head.html*. If you don't assign a thumbnail the default graphic *(default-thumb.png)* is used. I'd suggest changing this to something more meaningful --- your logo or avatar are good options.
2013-05-24 16:25:31 +02:00
#### Table of Contents
Any article or page that you want a *table of contents* to render insert the following HTML in your post before the actual content. [Kramdown will take care of the rest](http://kramdown.rubyforge.org/converter/html.html#toc) and convert all headlines into a contents list.
2013-09-09 18:20:51 +02:00
**PS:** The TOC is hidden on small devices because I haven't gotten around to optimizing it. For now it only appears on larger screens (tablet and desktop).
2013-05-24 16:25:31 +02:00
{: .notice}
2013-05-28 15:00:43 +02:00
{% highlight html %}
2013-05-24 16:25:31 +02:00
<section id="table-of-contents" class="toc">
<header>
<h3>Contents</h3>
2013-05-24 16:25:31 +02:00
</header>
<div id="drawer" markdown="1">
* Auto generated table of contents
{:toc}
</div>
</section><!-- /#table-of-contents -->
2013-05-28 15:00:43 +02:00
{% endhighlight %}
2013-05-24 16:25:31 +02:00
#### Videos
Video embeds are responsive and scale with the width of the main content block with the help of [FitVids](http://fitvidsjs.com/).
Not sure if this only effects Kramdown or if it's an issue with Markdown in general. But adding YouTube video embeds causes errors when building your Jekyll site. To fix add a space between the `<iframe>` tags and remove `allowfullscreen`. Example below:
2013-05-28 15:00:43 +02:00
{% highlight html %}
2013-05-24 16:25:31 +02:00
<iframe width="560" height="315" src="http://www.youtube.com/embed/PWf4WUoMXwg" frameborder="0"> </iframe>
2013-05-28 15:00:43 +02:00
{% endhighlight %}
2013-05-24 16:25:31 +02:00
2013-09-09 18:20:51 +02:00
---
## Theme Development
If you want to easily skin the themes' colors and fonts, take a look at `variables.less` in `assets/less/` and make the necessary changes to the color and font variables. To make development easier I setup a Grunt build script to compile/minify the LESS files into `main.min.css` and lint/concatenate/minify all scripts into `scripts.min.js`. [Install Node.js](http://nodejs.org/), then [install Grunt](http://gruntjs.com/getting-started), and then finally install the dependencies for the theme contained in `package.json`:
{% highlight bash %}
npm install
{% endhighlight %}
2013-09-09 18:20:51 +02:00
From the theme's root, use `grunt` to rebuild the CSS, concatenate JavaScript files, and optimize .jpg, .png, and .svg files in the `images/` folder. You can also use `grunt watch` in combination with `jekyll build --watch` to watch for updates to your LESS and 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.
And if the command line isn't your thing (you're using Jekyll so it probably is), [CodeKit](http://incident57.com/codekit/) for Mac OS X and [Prepros](http://alphapixels.com/prepros/) for Windows are great alternatives.
---
## Questions?
2014-02-20 20:55:25 +01:00
Having a problem getting something to work or want to know why I setup something in a certain way? Ping me on Twitter [@mmistakes](http://twitter.com/mmistakes) or [file a GitHub Issue](https://github.com/mmistakes/minimal-mistakes/issues/new). And if you make something cool with this theme feel free to let me know.
2013-09-09 18:20:51 +02:00
---
## License
This theme is free and open source software, distributed under the [GNU General Public License]({{ site.url }}/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.
2013-12-09 15:16:56 +01:00
[^1]: Used to generate absolute urls in `sitemap.xml`, `feed.xml`, and for canonical urls in `_head.html`. Don't include a trailing `/` in your base url ie: `http://mademistakes.com`. When developing locally remove or comment out this line so local .css, .js, and images are used.
2013-05-24 20:30:56 +02:00
2013-09-09 18:20:51 +02:00
[^2]: 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.