171 lines
8.2 KiB
Markdown
171 lines
8.2 KiB
Markdown
---
|
|
layout: page
|
|
permalink: /theme-setup/index.html
|
|
title: Theme Setup
|
|
description: "Instructions on how to install and customize the Jekyll theme Minimal Mistakes."
|
|
tags: [Jekyll, theme, responsive]
|
|
image:
|
|
feature: texture-feature-02.jpg
|
|
---
|
|
|
|
<section id="table-of-contents" class="toc">
|
|
<header>
|
|
<h3 class="delta">Contents</h3>
|
|
</header>
|
|
<div id="drawer" markdown="1">
|
|
* Auto generated table of contents
|
|
{:toc}
|
|
</div>
|
|
</section><!-- /#table-of-contents -->
|
|
|
|
General notes and suggestions for customizing Minimal Mistakes.
|
|
|
|
## Basic Setup
|
|
|
|
1. [Install Jekyll](http://jekyllrb.com) if you haven't already.
|
|
2. Fork the [Minimal Mistakes repo](http://github.com/mmistakes/minimal-mistakes/)
|
|
3. Make it your own and customize, customize, customize.
|
|
|
|
<a markdown="0" href="http://github.com/mmistakes/minimal-mistakes" class="btn">Minimal Mistakes on GitHub</a>
|
|
|
|
{% highlight text %}
|
|
minimal-mistakes/
|
|
├── _includes
|
|
| ├── author-bio.html //bio stuff goes here
|
|
| ├── chrome-frame.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.
|
|
├── _layouts
|
|
| ├── home.html //homepage layout
|
|
| ├── page.html //page layout
|
|
| ├── post-index.html //post listing layout
|
|
| └── post.html //post layout
|
|
├── _posts
|
|
├── assets
|
|
| ├── css //preprocessed less styles. good idea to minify
|
|
| ├── img //images and graphics used in css and js
|
|
| ├── js
|
|
| | ├── main.js //jQuery plugins and settings
|
|
| | └── vendor //all 3rd party scripts
|
|
| └── less
|
|
├── images //images for posts and pages
|
|
├── about.md //about page
|
|
├── articles.md //lists all posts from latest to oldest
|
|
└── index.md //homepage. lists 5 most recent posts
|
|
{% endhighlight %}
|
|
|
|
## Customization
|
|
|
|
### _config.yml
|
|
|
|
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 }}` 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`.
|
|
|
|
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 and/or remove `<link rel="author" href="{{ site.owner.google_plus }}">` from `head.html`.
|
|
|
|
#### 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: Articles
|
|
url: /articles
|
|
- title: Other Page
|
|
url: /other-page
|
|
- title: External Page
|
|
url: http://mademistakes.com
|
|
external: true
|
|
{% endhighlight %}
|
|
|
|
### 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 text heavy blog posts (or articles).
|
|
|
|
#### Feature Images
|
|
|
|
A good rule of thumb is to keep feature images[^2] nice and wide so you don't push the body text too far down. An image cropped around around 1024 x 512 pixels will keep file size down with an acceptable resolution for most devices. On my personal site I use [Picturefill](https://github.com/scottjehl/picturefill) to serve the same image responsively in four different flavors (small, medium, large, and extra large). In the interest of keeping things simple with this theme I left that script out, but you can certainly [add it back in](https://github.com/mmistakes/made-mistakes#articles-and-pages) or give [Adaptive Images](http://adaptive-images.com/) a try.
|
|
|
|
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.
|
|
|
|
{% highlight yaml %}
|
|
image:
|
|
feature: feature-image-filename.jpg
|
|
thumb: thumbnail-image.jpg #keep it square 200x200 px is good
|
|
{% endhighlight %}
|
|
|
|
#### Thumbnails for OG and Twitter Cards
|
|
|
|
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.
|
|
|
|
#### 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.
|
|
|
|
**PS:** The TOC is hidden on small devices because I haven't gotten around to optimizing it. For now it only shows on tablets and desktop viewports...
|
|
{: .notice}
|
|
|
|
{% highlight html %}
|
|
<section id="table-of-contents" class="toc">
|
|
<header>
|
|
<h3 class="delta">Contents</h3>
|
|
</header>
|
|
<div id="drawer" markdown="1">
|
|
* Auto generated table of contents
|
|
{:toc}
|
|
</div>
|
|
</section><!-- /#table-of-contents -->
|
|
{% endhighlight %}
|
|
|
|
#### 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:
|
|
|
|
{% highlight html %}
|
|
<iframe width="560" height="315" src="http://www.youtube.com/embed/PWf4WUoMXwg" frameborder="0"> </iframe>
|
|
{% endhighlight %}
|
|
|
|
## Further Customization
|
|
|
|
To make things easier I use LESS to build Minimal Mistakes' stylesheets. If you want to make some minor cosmetic alterations, take a look at `variables.less` in `assets/less/`. Changing some of the following variables can help make the theme your own. Just compile `main.less` and `ie.less` using your preprocessor of choice and off you go --- I like [CodeKit](http://incident57.com/codekit/) and [Prepros](http://alphapixels.com/prepros/).
|
|
|
|
{% highlight css %}
|
|
// TYPOGRAPHY ================================================
|
|
@basefont: 'PT Serif', serif;
|
|
@baseheadingfont: 'PT Sans Narrow', sans-serif;
|
|
@codefont: Monaco, Courier New, monospace;
|
|
|
|
// COLOR ====================================================
|
|
@bodycolor : #ebebeb;
|
|
@textcolor : #333332;
|
|
@basecolor : #343434;
|
|
@compcolor : spin(@basecolor, 180);
|
|
@bordercolor : @basecolor;
|
|
@white : #fff;
|
|
@black : #000;
|
|
@accentcolor : @black;
|
|
/* Links ================================================= */
|
|
@linkcolor : #343434;
|
|
@linkcolorhover : darken(@linkcolor, 10);
|
|
@linkcolorvisited : lighten(@linkcolorhover, 20);
|
|
@linkcolorfocus : darken(@linkcolorvisited, 10);
|
|
{% endhighlight %}
|
|
|
|
|
|
[^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.
|
|
|
|
[^2]: Feature images supplied by [Love Textures](http://www.lovetextures.com/) |