hacks-guide/minimal-mistakes
1
0
Fork 0
mirror of https://github.com/hacks-guide/minimal-mistakes.git synced 2024-11-27 10:50:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
📐 Jekyll theme for building a personal site, blog, project documentation, or portfolio.
186 Commits 2 Branches 0 Tags 46 MiB
HTML 47.5%
SCSS 45.7%
JavaScript 3.7%
Ruby 3.1%
a6dcf3a9e7
Go to file
Maximilian Held a6dcf3a9e7 Site.owner.avatar now accepts local images and hotlinked images (conditional on http://, https:// in string)
2014-03-10 16:25:07 +01:00
_includes Site.owner.avatar now accepts local images and hotlinked images (conditional on http://, https:// in string) 2014-03-10 16:25:07 +01:00
_layouts Add category to rake new_post 2014-02-27 15:00:37 -05:00
_posts Remove barely used tagline variable 2014-02-27 14:15:27 -05:00
assets Add new icons and profile links to sidebar for Stackoverflow, Pinterest, Foursquare, Steam, and Dribbble. 2014-02-27 15:24:05 -05:00
images Update theme screenshot 2014-02-13 16:34:06 -05:00
_config.yml Add new icons and profile links to sidebar for Stackoverflow, Pinterest, Foursquare, Steam, and Dribbble. 2014-02-27 15:24:05 -05:00
.gitignore Add category to rake new_post 2014-02-27 15:00:37 -05:00
.jshintrc Init Gruntjs build script 2013-09-09 10:12:07 -04:00
404.md Add custom 404 page 2013-09-07 13:08:00 -04:00
about.md Rename Articles to Posts to stay consistent with Jekyll naming conventions 2014-01-15 15:32:48 -05:00
favicon.ico Minor cleanup 2013-05-24 12:04:43 -04:00
favicon.png Add favicons and iOS icons 2013-05-28 10:43:55 -04:00
feed.xml Remove barely used tagline variable 2014-02-27 14:15:27 -05:00
Gemfile Bring back Gemfile 2014-02-27 15:34:55 -05:00
Gemfile.lock Bring back Gemfile 2014-02-27 15:34:55 -05:00
Gruntfile.js Create media query mixins and consolidate .less files 2014-02-13 13:29:42 -05:00
index.md Add image attribution for post and page feature images 2013-09-07 09:05:36 -04:00
LICENSE Update theme setup documentation 2013-09-09 12:20:51 -04:00
package.json Init Gruntjs build script 2013-09-09 10:12:07 -04:00
posts.md Rename Articles to Posts to stay consistent with Jekyll naming conventions 2014-01-15 15:32:48 -05:00
Rakefile.rb Add category to rake new_post 2014-02-27 15:00:37 -05:00
README.md Revert "Update" 2014-02-27 15:33:38 -05:00
sitemap.xml Add pages to sitemap 2014-02-17 08:19:22 -05:00
theme-setup.md Add category to rake new_post 2014-02-27 15:00:37 -05:00

README.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.

screenshot of Minimal Mistakes theme

Basic Setup for a new Jekyll site

  1. Install Bundler gem install bundler and then install Jekyll and all dependencies bundle install.
  2. Fork the Minimal Mistakes repo.
  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

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.