fa1edfffdd
add info about notices in sample post |
||
---|---|---|
_includes | ||
_layouts | ||
_posts | ||
assets | ||
images | ||
.gitignore | ||
.jshintrc | ||
404.md | ||
_config.yml | ||
about.md | ||
favicon.ico | ||
favicon.png | ||
feed.xml | ||
Gemfile | ||
Gemfile.lock | ||
Gruntfile.js | ||
index.md | ||
LICENSE | ||
package.json | ||
posts.md | ||
Rakefile.rb | ||
README.md | ||
sitemap.xml | ||
theme-setup.md |
Minimal Mistakes
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 to get you started.
- Stylesheets for Pygments and Coderay syntax highlighting to make your code examples look snazzy.
Basic Setup for a new Jekyll site
- Install Bundler
gem install bundler
and then install Jekyll and all dependenciesbundle install
. - Fork the Minimal Mistakes repo.
- Clone the repo you just forked and rename it.
- Edit
_config.yml
to personalize your site. - Check out the sample posts in
_posts
to see examples for pulling in large feature images, assigning categories and tags, and other YAML data.
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.
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 or file a GitHub Issue. 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 version 2 or later. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.