866fb17d9e
* Add jekyll-toc include * Reduce whitespace generated by comments * Add table of contents include to `single` layout * Replace `toc` include with jekyll-toc enabled YAML Front Matter * Update README * Update table of contents documentation - Revise `toc` helper include to mention that it will be deprecated in the next major version. - Add documentation to `single` layout explaining how to enable table of contents on those pages. * Update CHANGELOG and history * Update LICENSE Close #1222
84 lines
5 KiB
Markdown
84 lines
5 KiB
Markdown
---
|
|
permalink: /about/
|
|
title: "About"
|
|
excerpt: "Minimal Mistakes is a flexible two-column Jekyll theme."
|
|
layouts_gallery:
|
|
- url: /assets/images/mm-layout-splash.png
|
|
image_path: /assets/images/mm-layout-splash.png
|
|
alt: "splash layout example"
|
|
- url: /assets/images/mm-layout-single-meta.png
|
|
image_path: /assets/images/mm-layout-single-meta.png
|
|
alt: "single layout with comments and related posts"
|
|
- url: /assets/images/mm-layout-archive.png
|
|
image_path: /assets/images/mm-layout-archive.png
|
|
alt: "archive layout example"
|
|
last_modified_at: 2017-10-20T12:43:30-04:00
|
|
toc: true
|
|
---
|
|
|
|
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 :smile:.
|
|
|
|
{% include gallery id="layouts_gallery" caption="Examples of included layouts `splash`, `single`, and `archive`." %}
|
|
|
|
[Install the Theme]({{ "/docs/quick-start-guide/" | absolute_url }}){: .btn .btn--success .btn--large}
|
|
|
|
## 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](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
|
|
- Optional [header images](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#headers), [custom sidebars](https://mmistakes.github.io/minimal-mistakes/docs/layouts/#sidebars), [table of contents](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#table-of-contents), [galleries](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#gallery), related posts, [breadcrumb links](https://mmistakes.github.io/minimal-mistakes/docs/configuration/#breadcrumb-navigation-beta), [navigation lists](https://mmistakes.github.io/minimal-mistakes/docs/helpers/#navigation-list), and more.
|
|
- Commenting support (powered by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman v1 and v2](https://staticman.net/), and custom).
|
|
- [Google Analytics](https://www.google.com/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.
|
|
|
|
## Demo Pages
|
|
|
|
| Name | Description |
|
|
| ------------------------------------------- | ----------------------------------------------------- |
|
|
| [Post with Header Image][header-image-post] | A post with a large header image. |
|
|
| [HTML Tags and Formatting Post][html-tags-post] | A variety of common markup showing how the theme styles them. |
|
|
| [Syntax Highlighting Post][syntax-post] | Post displaying highlighted code. |
|
|
| [Post with a Gallery][gallery-post] | A post showing several images wrapped in `<figure>` elements. |
|
|
| [Sample Collection Page][sample-collection] | Single page from a collection. |
|
|
| [Categories Archive][categories-archive] | Posts grouped by category. |
|
|
| [Tags Archive][tags-archive] | Posts grouped by tag. |
|
|
|
|
For even more demo pages check the [posts archive][year-archive].
|
|
|
|
[header-image-post]: {{ "" | absolute_url }}{% post_url 2012-03-15-layout-header-image-text-readability %}
|
|
[gallery-post]: {{ "" | absolute_url }}{% post_url 2010-09-09-post-gallery %}
|
|
[html-tags-post]: {{ "" | absolute_url }}{% post_url 2013-01-11-markup-html-tags-and-formatting %}
|
|
[syntax-post]: {{ "" | absolute_url }}{% post_url 2013-08-16-markup-syntax-highlighting %}
|
|
[sample-collection]: {{ "/recipes/chocolate-chip-cookies/" | absolute_url }}
|
|
[categories-archive]: {{ "/categories/" | absolute_url }}
|
|
[tags-archive]: {{ "/tags/" | absolute_url }}
|
|
[year-archive]: {{ "/year-archive/" | absolute_url }}
|
|
|
|
---
|
|
|
|
## Credits
|
|
|
|
### Icons + Demo Images:
|
|
|
|
- [The Noun Project](https://thenounproject.com) -- Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam)
|
|
- [Font Awesome](http://fontawesome.io/)
|
|
- [Unsplash](https://unsplash.com/)
|
|
|
|
### Other:
|
|
|
|
- [Jekyll](https://jekyllrb.com/)
|
|
- [jQuery](https://jquery.com/)
|
|
- [Susy](http://susy.oddbird.net/)
|
|
- [Breakpoint](http://breakpoint-sass.com/)
|
|
- [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/)
|
|
- [FitVids.JS](http://fitvidsjs.com/)
|
|
- Greedy Navigation - [lukejacksonn](https://codepen.io/lukejacksonn/pen/PwmwWV)
|
|
- [jQuery Smooth Scroll](https://github.com/kswedberg/jquery-smooth-scroll)
|
|
|
|
---
|
|
|
|
Minimal Mistakes is designed, developed, and maintained by Michael Rose. Just another boring, tattooed, designer from Buffalo New York.
|