Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 2ad8971

Browse files
committedOct 7, 2016
Update README
1 parent 50d4b1b commit 2ad8971

File tree

3 files changed

+40
-16
lines changed

3 files changed

+40
-16
lines changed
 

‎README.md

+40-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/)
22

3-
[![GitHub release](https://img.shields.io/github/release/mmistakes/minimal-mistakes.svg)](https://github.com/mmistakes/minimal-mistakes/releases) [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE)
3+
[![GitHub release](https://img.shields.io/gem/v/minimal-mistakes-jekyll.svg)](https://github.com/mmistakes/minimal-mistakes/releases) [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/mmistakes/minimal-mistakes/master/LICENSE)
44

55
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:.
66

@@ -9,26 +9,22 @@ See what's new in the [CHANGELOG](CHANGELOG.md).
99
[![Minimal Mistakes live preview][2]][1]
1010

1111
[1]: https://mmistakes.github.io/minimal-mistakes/
12-
[2]: images/mm-browser-mockups.png (live preview)
12+
[2]: screenshot.png (live preview)
1313

14-
The theme includes responsive layouts (`single`, `archive`, and `splash` pages) that look great on mobile and desktop browsers.
14+
![layout examples](screenshot-layouts.png)
1515

16-
![layout examples](images/mm-layout-examples.png)
17-
18-
## [Installation and Setup](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/) / [Preview the Theme](https://mmistakes.github.io/minimal-mistakes/)
19-
20-
### Notable Features
16+
## Notable Features
2117

2218
- Compatible with Jekyll 3.x and GitHub Pages
2319
- Support for Jekyll's built-in Sass/SCSS preprocessor
24-
- Several layout options (single, archive, splash pages)
20+
- Several responsive layout options (single, archive index, splash, and paginated home page)
2521
- SEO optimized with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
26-
- Optional header images, sidebars, table of contents, galleries, related posts, breadcrumb links, and more.
27-
- Optional comments ([Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman](https://staticman.net/), and custom).
28-
- Optional analytics ([Google Analytics](https://www.google.com/analytics/) and custom).
29-
- UI localized text: English (default), Spanish, French, and Turkish.
22+
- Optional header images, sidebars, table of contents, galleries, related posts, breadcrumb links, navigation lists, and more.
23+
- Commenting support (powere by [Disqus](https://disqus.com/), [Facebook](https://developers.facebook.com/docs/plugins/comments), Google+, [Discourse](https://www.discourse.org/), static-based via [Staticman](https://staticman.net/), and custom).
24+
- [Google Analytics](https://www.google.com/analytics/) support.
25+
- UI localized text in English (default), Brazilian Portguese, Chinese, French, German, Italian, Spanish, and Turkish
3026

31-
#### Demo Pages
27+
## Demo Pages
3228

3329
| Name | Description |
3430
| ------------------------------------------- | ----------------------------------------------------- |
@@ -40,7 +36,7 @@ The theme includes responsive layouts (`single`, `archive`, and `splash` pages)
4036
| [Categories Archive][categories-archive] | Posts grouped by category. |
4137
| [Tags Archive][tags-archive] | Posts grouped by tags. |
4238

43-
For even more demo pages check the [posts archive][year-archive].
39+
For even more demo pages check the [posts archive][year-archive] on the demo site. Looking for the source code to peep the YAML Front Matter and Markdown used? Check the [`gh-pages`](https://github.com/mmistakes/minimal-mistakes/tree/gh-pages) branch.
4440

4541
[header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/
4642
[gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/
@@ -51,6 +47,32 @@ For even more demo pages check the [posts archive][year-archive].
5147
[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/
5248
[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/
5349

50+
## Quick Start
51+
52+
Add this line to your Jekyll site's `Gemfile`:
53+
54+
```ruby
55+
gem "minimal-mistakes-jekyll"
56+
```
57+
58+
Add this line to your Jekyll site's `_config.yml` file:
59+
60+
```yaml
61+
theme: minimal-mistakes-jekyll
62+
```
63+
64+
Run Bundler:
65+
66+
```bash
67+
bundle install
68+
```
69+
70+
## Usage
71+
72+
For detailed instructions on how to configure, customize, add content, and more read the [theme's documentation](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/).
73+
74+
**Note:** Gem version of the theme requires Jekyll v3.3+ and is not supported with sites hosted with [GitHub Pages](https://pages.github.com/). You can still use the theme on GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)".
75+
5476
---
5577

5678
## Contributing
@@ -65,6 +87,8 @@ This goes for author sidebar links and "share button" additions -- I have no int
6587

6688
To help me out try to avoid creating pull requests on `master` and instead branch off of `develop`. It's much easier for me to test, merge, and roll them into new releases this way.
6789

90+
Theme documentation and demo pages can be found in the `gh-pages` branch, please submit pull requests against that branch.
91+
6892
---
6993

7094
## Credits
@@ -119,4 +143,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
119143
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
120144
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
121145
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
122-
SOFTWARE.
146+
SOFTWARE.

‎assets/images/mm-browser-mockups.png

-206 KB
Binary file not shown.
File renamed without changes.

0 commit comments

Comments
 (0)