|
1 | 1 | # Minimal Mistakes |
2 | 2 |
|
3 | | -**[Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes)** is a two column responsive Jekyll theme perfect for powering your GitHub hosted blog. |
| 3 | +**[Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes)** is a two column responsive Jekyll theme perfect for powering your GitHub hosted blog. |
4 | 4 |
|
5 | 5 | ## Minimal Mistakes is all about: |
6 | 6 |
|
|
10 | 10 | * Optional large feature images for posts and pages. |
11 | 11 | * Simple and clear permalink structure. |
12 | 12 | * [Custom 404 page](http://mmistakes.github.io/minimal-mistakes/404.html) to get you started. |
13 | | -* Stylesheets for Pygments and Coderay [syntax highlighting](http://mmistakes.github.io/minimal-mistakes/articles/code-highlighting-post/) to make your code examples look snazzy. |
| 13 | +* Support for Disqus Comments |
14 | 14 |
|
15 | 15 |  |
16 | 16 |
|
17 | | -## Basic Setup for a new Jekyll site |
| 17 | +See a [live version of Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes/) hosted on GitHub. |
18 | 18 |
|
19 | | -1. [Install Bundler](http://bundler.io) `gem install bundler` and then install [Jekyll](http://jekyllrb.com) and all dependencies `bundle install`. |
20 | | -2. Fork the [Minimal Mistakes repo](http://github.com/mmistakes/minimal-mistakes/fork). |
21 | | -3. Clone the repo you just forked and rename it. |
22 | | -4. Edit `_config.yml` to personalize your site. |
23 | | -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. |
| 19 | +## Getting Started |
24 | 20 |
|
25 | | -[Demo the Theme](http://mmistakes.github.io/minimal-mistakes) |
| 21 | +Minimal Mistakes takes advantage of Sass and data files to make customizing easier. These features require Jekyll 2+ and will not work with older versions of Jekyll. |
26 | 22 |
|
27 | | -**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 need. |
28 | | - |
29 | | -## More Theme Setup Goodness |
30 | | - |
31 | | -To learn more about how customize this theme, include feature images in posts, use the Grunt build scripts, and some other junk, [read up here](http://mmistakes.github.io/minimal-mistakes/theme-setup/). |
32 | | - |
33 | | - |
34 | | ---- |
35 | | - |
36 | | -## Questions? |
37 | | - |
38 | | -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. |
39 | | - |
40 | | ---- |
41 | | - |
42 | | -## License |
43 | | - |
44 | | -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. |
| 23 | +To learn more about how install and use this theme check out the [Setup Guide](http://mmistakes.github.io/minimal-mistakes/theme-setup/) for more information. |
0 commit comments