Skip to content

Latest commit

 

History

History
187 lines (136 loc) · 10.5 KB

README.md

File metadata and controls

187 lines (136 loc) · 10.5 KB

Development

##Testing To set up your environment to develop this theme, run bundle install.

To test the theme, run bundle exec jekyll serve and open your browser at http://localhost:4000/. This starts a Jekyll server and that will regenerate. You should see the changes in the browser after a refresh.

Adding a Project

  1. Add a new .md file to the _projects/ folder
    • make sure to start the file name with next number available so projects are ordered from newest to oldest
  2. Add a description to the .md file
    • copy the basic structure from the other files
    • any links to work/projects need to start with "/"
  3. Add an image for the thumbnail to the assets/images/ folder
    • change the "teaser" in the new .md file to match the path for your image

Adding a Work Experience

  1. Refer to the above section about adding a project
    • use the _work folder instead of the _projects folder
  2. If you added any projects with this work, make sure they link to each other
    • any links to work/projects need to start with "/"

Adding a Page

  1. In the ~/_pages folder

Theme

GitHub release GitHub license

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

✨ See what's new in the CHANGELOG.

Minimal Mistakes live preview

layout examples

Notable Features

  • Bundled as a "theme gem" for easier install/upgrading.
  • Compatible with GitHub Pages.
  • Support for Jekyll's built-in Sass/SCSS preprocessor.
  • Seven different skins (color variations).
  • Several responsive layout options (single, archive index, splash, and paginated home page).
  • Optimized for search engines with support for Twitter Cards and Open Graph data
  • Optional header images, custom sidebars, table of contents, galleries, related posts, breadcrumb links, navigation lists, and more.
  • Commenting support (powered by Disqus, Facebook, Google+, Discourse, static-based via Staticman v1, and custom).
  • Google Analytics support.
  • UI localized text in English (default), Brazilian Portuguese (Português brasileiro), Chinese, Danish, Dutch, French (Français), German (Deutsch), Greek, Indonesian, Italian (Italiano), Korean, Nepali (Nepalese), Polish, Russian, Spanish (Español), Swedish, Turkish (Türkçe), and Vietnamese.

Skins (Color Variations)

This theme comes in seven different skins (including the default one).

air contrast dark
air skin contrast skin dark skin
dirt mint sunrise
dirt skin mint skin sunrise skin

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

Additional sample posts are available under posts archive on the demo site. Source files for these (and the entire demo site) can be found in /docs.

Usage

For detailed instructions on how to configure, customize, add content, and more read the theme's documentation.

Note: Gem version of the theme requires Jekyll v3.3+ and is not currently supported on GitHub Pages. You can still use the theme with GitHub Pages, you'll just need to install using the old "repo fork method".


Credits

Creator

Michael Rose

Icons + Demo Images:

Other:


License

The MIT License (MIT)

Copyright (c) 2017 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.

Minimal Mistakes incorporates icons from The Noun Project creators Garrett Knoll, Arthur Shlain, and tracy tam. Icons are distributed under Creative Commons Attribution 3.0 United States (CC BY 3.0 US).

Minimal Mistakes incorporates Font Awesome, Copyright (c) 2017 Dave Gandy. Font Awesome is distributed under the terms of the SIL OFL 1.1 and MIT License.

Minimal Mistakes incorporates photographs from Unsplash.

Minimal Mistakes incorporates Susy, Copyright (c) 2017, Miriam Eric Suzanne. Susy is distributed under the terms of the BSD 3-clause "New" or "Revised" License.

Minimal Mistakes incorporates Breakpoint. Breakpoint is distributed under the terms of the MIT/GPL Licenses.

Minimal Mistakes incorporates FitVids.js, Copyright (c) 2013 Dave Rubert and Chris Coyier. FitVids is distributed under the terms of the WTFPL License.

Minimal Mistakes incorporates Magnific Popup, Copyright (c) 2014-2016 Dmitry Semenov, http://dimsemenov.com. Magnific Popup is distributed under the terms of the MIT License.

Minimal Mistakes incorporates jQuery Smooth Scroll, Copyright (c) 2017 Karl Swedberg. jQuery Smooth Scroll is distributed under the terms of the MIT License.

Minimal Mistakes incorporates GreedyNav.js, Copyright (c) 2015 Luke Jackson. GreedyNav.js is distributed under the terms of the MIT License.

Minimal Mistakes incorporates Jekyll Group-By-Array, Copyright (c) 2015 Max White mushishi78@gmail.com. Jekyll Group-By-Array is distributed under the terms of the MIT License.