44 lines
2.5 KiB
Markdown
44 lines
2.5 KiB
Markdown
# Minimal Mistakes
|
|
|
|
**[Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes)** is a two column responsive Jekyll theme perfect for powering your GitHub hosted blog.
|
|
|
|
## 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.
|
|
* Minimal embellishments -- content first.
|
|
* Optional large feature images for posts and pages.
|
|
* 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/minimal-mistakes/articles/code-highlighting-post/) to make your code examples look snazzy.
|
|
|
|
|
|
|
|
## Basic Setup for a new Jekyll site
|
|
|
|
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.
|
|
|
|
[Demo the Theme](http://mmistakes.github.io/minimal-mistakes)
|
|
|
|
**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.
|
|
|
|
## More Theme Setup Goodness
|
|
|
|
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/).
|
|
|
|
|
|
---
|
|
|
|
## 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](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.
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
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.
|