hacks-guide-minimal-mistake.../README.md

98 lines
3.9 KiB
Markdown
Raw Normal View History

2013-05-24 21:20:25 +02:00
# Minimal Mistakes
2013-09-09 18:20:51 +02:00
**[Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes)** is a two column responsive Jekyll theme perfect for powering your GitHub hosted blog.
2013-05-24 21:20:25 +02:00
## 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.
2013-09-09 18:20:51 +02:00
* Minimal embellishments. Content first; other widget nonsense never.
2013-05-24 21:20:25 +02:00
* Large feature images for posts and pages.
2013-09-09 18:20:51 +02:00
* Simple and clear permalink structure.
* [Custom 404 page](http://mmistakes.github.io/minimal-mistakes/404.html) to get you started.
* Stylesheets for Pygments and Coderay [syntax highlighting](http://mmistakes.github.io/articles/minimal-mistakes/code-highlighting-post/) to make your code examples look snazzy.
2013-05-24 21:20:25 +02:00
2013-05-24 21:26:50 +02:00
![screenshot of Minimal Mistakes theme](http://mmistakes.github.io/minimal-mistakes/images/mm-theme-post-600.jpg)
2013-05-24 21:20:25 +02:00
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/)
2013-09-09 18:20:51 +02:00
3. Clone the repo you just forked to your computer.
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, tags, and other YAML data.
6. Read the documentation below for further customization pointers and documentation.
2013-05-24 21:20:25 +02:00
2013-09-09 18:20:51 +02:00
[Download the Theme](https://github.com/mmistakes/minimal-mistakes)
2013-09-09 18:20:51 +02:00
**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.
2013-09-09 18:20:51 +02:00
---
2013-09-09 18:20:51 +02:00
## Setup for an Existing Jekyll site
2013-09-09 18:20:51 +02:00
1. Clone the following folders: `_includes`, `_layouts`, `assets`, and `images`.
2. Clone the following files and personalize content as need: `about.md`, `articles.html`, `index.md`, `feed.xml`, `sitemap.xml`
3. Set the following variables in your `config.yml` file:
2013-06-06 17:51:01 +02:00
``` yaml
2013-09-09 18:20:51 +02:00
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
2013-06-06 17:51:01 +02:00
links:
2013-09-09 18:20:51 +02:00
- title: Theme Setup
url: /theme-setup
- title: External Link
url: http://mademistakes.com
external: true
2013-05-24 21:20:25 +02:00
2013-09-09 18:20:51 +02:00
# http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
timezone: America/New_York
future: true
pygments: true
markdown: kramdown
2013-05-24 21:20:25 +02:00
```
2013-09-09 18:20:51 +02:00
---
2013-06-06 17:51:01 +02:00
## Questions?
2013-09-09 18:20:51 +02: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/minima-mistakes/issues/new). And if you make something cool with this theme feel free to let me know.
2013-06-06 17:51:01 +02:00
2013-09-09 18:20:51 +02:00
---
2013-05-28 17:43:29 +02:00
2013-09-09 18:20:51 +02:00
## License
2013-05-28 17:43:29 +02:00
2013-09-09 18:20:51 +02:00
This theme is free and open source software, distributed under the [GNU General Public License](http://mmistakes.github.io/minimal-mistakes/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.