hacks-guide/minimal-mistakes
1
0
Fork 0
mirror of https://github.com/hacks-guide/minimal-mistakes.git synced 2024-11-24 01:09:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
📐 Jekyll theme for building a personal site, blog, project documentation, or portfolio.
707 Commits 2 Branches 0 Tags 46 MiB
HTML 47.5%
SCSS 45.7%
JavaScript 3.7%
Ruby 3.1%
d9c6183ed7
Go to file
Michael Rose d9c6183ed7 Fix table of contents z-index stacking bug with <code> blocks 
- Close #263
2016-04-14 21:31:53 -04:00
_data Reduce config to bare minimum and remove sample content 2016-04-14 15:35:33 -04:00
_includes Fix bug when site.twitter is null 2016-04-14 15:12:04 -04:00
_layouts Disable breadcrumbs on paginated home pages 2016-04-14 14:36:48 -04:00
_pages Reduce config to bare minimum and remove sample content 2016-04-14 15:35:33 -04:00
assets Fix table of contents z-index stacking bug with <code> blocks 2016-04-14 21:31:53 -04:00
images Reduce config to bare minimum and remove sample content 2016-04-14 15:35:33 -04:00
_config.yml Fix typo in URL example 2016-04-14 16:38:13 -04:00
.editorconfig Add editor config file 2016-02-24 16:15:19 -05:00
.gitattributes Try to get Linguist to ignore vendor files 2016-03-09 12:16:54 -05:00
.gitignore Ignore node .log files 2016-04-06 14:25:49 -04:00
CHANGELOG.md Add .md extension 2016-04-14 15:46:00 -04:00
Gemfile Add support for Jekyll Archives plugin 2016-03-11 09:39:20 -05:00
Gemfile.lock Update gems 2016-04-13 17:10:07 -04:00
index.html Reduce config to bare minimum and remove sample content 2016-04-14 15:35:33 -04:00
LICENSE Update docs 2016-04-13 17:10:01 -04:00
package.json Simplify build scripts to use npm instead of gulp 2016-03-31 20:55:54 -04:00
README.md Add layout examples to README 2016-04-14 15:53:10 -04:00

README.md

Minimal Mistakes Jekyll Theme

Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your personal site, blog, or portfolio on GitHub or self-hosting on your own server. As the name implies --- styling is purposely minimalistic to be enhanced and customized by you 😄.

The theme includes responsive layouts (single, archive, and splash pages) that look great on mobile and desktop browsers.

mm-layout-examples

Installation and Setup / Preview the Theme

Notable Features

  • Compatible with GitHub Pages
  • Several layout options (single, archive, splash pages)
  • SEO optimized with support for Twitter Cards and Open Graph data
  • Optional header images, sidebars, table of contents, galleries, related posts, breadcrumb links, and more.
  • Optional comments (Disqus, Facebook, Google+, and custom)
  • Optional analytics (Google Analytics and custom)

Demo Pages

Name Description
Post with Header Image A post with a large header image.
HTML Tags and Formatting Post A variety of common markup showing how the theme styles them.
Syntax Highlighting Post Post displaying highlighted code.
Post with a Gallery A post showing several images wrapped in <figure> elements.
Sample Collection Page Single page from a collection.
Categories Archive Posts grouped by category.
Tags Archive Posts grouped by tags.

For even more demo pages check the posts archive.

Credits

Icons + Demo Images:

Other:

The MIT License (MIT)

Copyright (c) 2016 Michael Rose

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.