Update README
This commit is contained in:
parent
23e291bd30
commit
9f99cf16b2
1 changed files with 76 additions and 14 deletions
90
README
90
README
|
@ -1,23 +1,85 @@
|
|||
# Minimal Mistakes Jekyll Theme
|
||||
|
||||
**[Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes)** is a two column responsive Jekyll theme perfect for powering your GitHub hosted blog built. Compatible with Jekyll 3.0 and up.
|
||||
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:.
|
||||
|
||||
## Minimal Mistakes is all about:
|
||||
The theme includes responsive layouts (`single`, `archive`, and `splash` pages) that look great on mobile and desktop browsers.
|
||||
|
||||
- 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](http://mmistakes.github.io/minimal-mistakes/404.html) to get you started.
|
||||
- Support for Disqus Comments
|
||||
## [Installation and Setup](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/) / [Preview the Theme](https://mmistakes.github.io/minimal-mistakes/)
|
||||
|
||||
![screenshot of Minimal Mistakes theme](http://mmistakes.github.io/minimal-mistakes/images/mm-theme-post-600.jpg)
|
||||
### Notable Features
|
||||
|
||||
See a [live version of Minimal Mistakes](http://mmistakes.github.io/minimal-mistakes/) hosted on GitHub.
|
||||
- Compatible with GitHub Pages
|
||||
- Several layout options (single, archive, splash pages)
|
||||
- SEO optimized with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
|
||||
- Optional header images, sidebars, table of contents, galleries, related posts, breadcrumb links, and more.
|
||||
- Optional comments ([Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, and custom)
|
||||
- Optional analytics ([Google Analytics](https://www.google.com/analytics/) and custom)
|
||||
|
||||
## Getting Started
|
||||
#### Demo Pages
|
||||
|
||||
Minimal Mistakes takes advantage of Sass and data files to make customizing easier. These features require [Jekyll 2.x](https://github.com/mmistakes/minimal-mistakes/releases/tag/2.1.3) and will not work with older versions of Jekyll.
|
||||
| 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 tags. |
|
||||
|
||||
To learn how to install and use this theme check out the [Setup Guide](http://mmistakes.github.io/minimal-mistakes/theme-setup/) for more information.
|
||||
For even more demo pages check the [posts archive][year-archive].
|
||||
|
||||
[header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/
|
||||
[gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/
|
||||
[html-tags-post]: https://mmistakes.github.io/minimal-mistakes/markup/markup-html-tags-and-formatting/
|
||||
[syntax-post]: https://mmistakes.github.io/minimal-mistakes/markup-syntax-highlighting/
|
||||
[sample-collection]: https://mmistakes.github.io/minimal-mistakes/recipes/chocolate-chip-cookies/
|
||||
[categories-archive]: https://mmistakes.github.io/minimal-mistakes/categories/
|
||||
[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/
|
||||
[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/
|
||||
|
||||
---
|
||||
|
||||
### Credits
|
||||
|
||||
#### Icons + Demo Images:
|
||||
|
||||
- [The Noun Project](https://thenounproject.com) -- Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam)
|
||||
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
|
||||
- [Unsplash](https://unsplash.com/)
|
||||
|
||||
#### Other:
|
||||
|
||||
- [Jekyll](http://jekyllrb.com/)
|
||||
- [jQuery](http://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](http://codepen.io/lukejacksonn/pen/PwmwWV)
|
||||
- [jQuery Smooth Scroll](https://github.com/kswedberg/jquery-smooth-scroll)
|
||||
- [Stickyfill](https://github.com/wilddeer/stickyfill)
|
||||
|
||||
---
|
||||
|
||||
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.
|
Loading…
Reference in a new issue