minimal-mistakes-jekyll 4.3.1 → 4.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +773 -758
- data/LICENSE.txt +20 -20
- data/README.md +160 -156
- data/_layouts/default.html +34 -34
- data/_layouts/single.html +3 -3
- data/_layouts/splash.html +1 -1
- data/_sass/minimal-mistakes.scss +40 -0
- data/_sass/{_animations.scss → minimal-mistakes/_animations.scss} +0 -0
- data/_sass/{_archive.scss → minimal-mistakes/_archive.scss} +0 -0
- data/_sass/{_base.scss → minimal-mistakes/_base.scss} +0 -0
- data/_sass/{_buttons.scss → minimal-mistakes/_buttons.scss} +0 -0
- data/_sass/{_footer.scss → minimal-mistakes/_footer.scss} +0 -0
- data/_sass/{_forms.scss → minimal-mistakes/_forms.scss} +0 -0
- data/_sass/{_masthead.scss → minimal-mistakes/_masthead.scss} +0 -0
- data/_sass/{_mixins.scss → minimal-mistakes/_mixins.scss} +0 -0
- data/_sass/{_navigation.scss → minimal-mistakes/_navigation.scss} +0 -0
- data/_sass/{_notices.scss → minimal-mistakes/_notices.scss} +0 -0
- data/_sass/{_page.scss → minimal-mistakes/_page.scss} +1 -1
- data/_sass/minimal-mistakes/_print.scss +238 -0
- data/_sass/{_reset.scss → minimal-mistakes/_reset.scss} +0 -0
- data/_sass/{_sidebar.scss → minimal-mistakes/_sidebar.scss} +0 -0
- data/_sass/{_syntax.scss → minimal-mistakes/_syntax.scss} +0 -0
- data/_sass/{_tables.scss → minimal-mistakes/_tables.scss} +0 -0
- data/_sass/{_utilities.scss → minimal-mistakes/_utilities.scss} +8 -1
- data/_sass/{_variables.scss → minimal-mistakes/_variables.scss} +127 -127
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_breakpoint.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_context.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_helpers.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_legacy-settings.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_no-query.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_parsers.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_respond-to.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/_settings.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/_double.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/_query.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/_resolution.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/_single.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/_triple.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/double/_default-pair.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/double/_default.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/double/_double-string.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/resolution/_resolution.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/single/_default.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/breakpoint/parsers/triple/_default.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_animated.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_bordered-pulled.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_core.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_fixed-width.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_font-awesome.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_icons.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_larger.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_list.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_mixins.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_path.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_rotated-flipped.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_screen-reader.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_stacked.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/font-awesome/_variables.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/magnific-popup/_magnific-popup.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/magnific-popup/_settings.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/_su.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/_susy.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/_susyone.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/_su.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/_susy.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/_susyone.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_background.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_bleed.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_box-sizing.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_breakpoint-plugin.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_container.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_context.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_gallery.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_grids.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_gutters.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_isolate.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_margins.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_padding.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_rows.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_settings.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_span.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susy/_validation.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_background.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_functions.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_grid.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_isolation.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_margin.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_media.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_padding.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/language/susyone/_settings.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/_float.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/_shared.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/_support.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/float/_container.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/float/_end.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/float/_isolate.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/float/_span.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_background.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_container.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_direction.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_inspect.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_margins.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_output.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/shared/_padding.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/support/_background.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/support/_box-sizing.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/support/_clearfix.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/support/_prefix.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/support/_rem.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/output/support/_support.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/su/_grid.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/su/_settings.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/su/_utilities.scss +0 -0
- data/_sass/{vendor → minimal-mistakes/vendor}/susy/susy/su/_validation.scss +0 -0
- data/assets/css/main.scss +7 -76
- data/assets/js/main.min.js +12 -12
- metadata +110 -109
- data/_sass/_print.scss +0 -18
data/LICENSE.txt
CHANGED
@@ -1,21 +1,21 @@
|
|
1
|
-
The MIT License (MIT)
|
2
|
-
|
3
|
-
Copyright (c)
|
4
|
-
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
7
|
-
in the Software without restriction, including without limitation the rights
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
10
|
-
furnished to do so, subject to the following conditions:
|
11
|
-
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
13
|
-
copies or substantial portions of the Software.
|
14
|
-
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Michael Rose
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
21
|
SOFTWARE.
|
data/README.md
CHANGED
@@ -1,156 +1,160 @@
|
|
1
|
-
# [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/)
|
2
|
-
|
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)
|
4
|
-
|
5
|
-
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:.
|
6
|
-
|
7
|
-
See what's new in the [CHANGELOG](CHANGELOG.md).
|
8
|
-
|
9
|
-
:sparkles: Minimal Mistakes is now available as a [Ruby gem](https://rubygems.org/gems/minimal-mistakes-jekyll). Consult the [Quick-Start Guide](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/) and [this blog post](https://mmistakes.github.io/minimal-mistakes/jekyll/gemified-theme-beta/) to learn how to upgrade.
|
10
|
-
|
11
|
-
[![Minimal Mistakes live preview][2]][1]
|
12
|
-
|
13
|
-
[1]: https://mmistakes.github.io/minimal-mistakes/
|
14
|
-
[2]: screenshot.png (live preview)
|
15
|
-
|
16
|
-
![layout examples](screenshot-layouts.png)
|
17
|
-
|
18
|
-
## Notable Features
|
19
|
-
|
20
|
-
- "Gemified" for easier install/upgrading
|
21
|
-
- Compatible with Jekyll 3.x and GitHub Pages
|
22
|
-
- Support for Jekyll's built-in Sass/SCSS preprocessor
|
23
|
-
- Several responsive layout options (single, archive index, splash, and paginated home page)
|
24
|
-
- SEO optimized with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
|
25
|
-
- 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.
|
26
|
-
- 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](https://staticman.net/), and custom).
|
27
|
-
- [Google Analytics](https://www.google.com/analytics/) support.
|
28
|
-
- UI localized text in English (default), Brazilian Portuguese, Chinese, French, German, Italian, Korean, Nepali (Nepalese), Russian, Spanish, and Turkish
|
29
|
-
|
30
|
-
## Demo Pages
|
31
|
-
|
32
|
-
| Name | Description |
|
33
|
-
| ------------------------------------------- | ----------------------------------------------------- |
|
34
|
-
| [Post with Header Image][header-image-post] | A post with a large header image. |
|
35
|
-
| [HTML Tags and Formatting Post][html-tags-post] | A variety of common markup showing how the theme styles them. |
|
36
|
-
| [Syntax Highlighting Post][syntax-post] | Post displaying highlighted code. |
|
37
|
-
| [Post with a Gallery][gallery-post] | A post showing several images wrapped in `<figure>` elements. |
|
38
|
-
| [Sample Collection Page][sample-collection] | Single page from a collection. |
|
39
|
-
| [Categories Archive][categories-archive] | Posts grouped by category. |
|
40
|
-
| [Tags Archive][tags-archive] | Posts grouped by tags. |
|
41
|
-
|
42
|
-
Additional sample posts are available under [posts archive][year-archive] on the demo site. Source files for these (and the entire demo site) can be found in [`/docs`](docs).
|
43
|
-
|
44
|
-
[header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/
|
45
|
-
[gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/
|
46
|
-
[html-tags-post]: https://mmistakes.github.io/minimal-mistakes/markup/markup-html-tags-and-formatting/
|
47
|
-
[syntax-post]: https://mmistakes.github.io/minimal-mistakes/markup-syntax-highlighting/
|
48
|
-
[sample-collection]: https://mmistakes.github.io/minimal-mistakes/recipes/chocolate-chip-cookies/
|
49
|
-
[categories-archive]: https://mmistakes.github.io/minimal-mistakes/categories/
|
50
|
-
[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/
|
51
|
-
[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/
|
52
|
-
|
53
|
-
## Usage
|
54
|
-
|
55
|
-
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/).
|
56
|
-
|
57
|
-
**Note:** Gem version of the theme requires Jekyll v3.3+ and is not currently supported on [GitHub Pages](https://pages.github.com/). You can still use the theme with GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)".
|
58
|
-
|
59
|
-
## Quick Start
|
60
|
-
|
61
|
-
Add this line to your Jekyll site's `Gemfile`:
|
62
|
-
|
63
|
-
```ruby
|
64
|
-
gem "minimal-mistakes-jekyll"
|
65
|
-
```
|
66
|
-
|
67
|
-
Add this line to your Jekyll site's `_config.yml` file:
|
68
|
-
|
69
|
-
```yaml
|
70
|
-
theme: minimal-mistakes-jekyll
|
71
|
-
```
|
72
|
-
|
73
|
-
Then run Bundler to install the theme gem and dependencies:
|
74
|
-
|
75
|
-
```bash
|
76
|
-
bundle install
|
77
|
-
```
|
78
|
-
|
79
|
-
To update the theme run `bundle update`.
|
80
|
-
|
81
|
-
---
|
82
|
-
|
83
|
-
## Contributing
|
84
|
-
|
85
|
-
Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)? Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new) or [pull request](https://help.github.com/articles/using-pull-requests/). If this is your first pull request, it may be helpful to read up on the [GitHub Flow](https://guides.github.com/introduction/flow/) first.
|
86
|
-
|
87
|
-
Minimal Mistakes has been designed as a base for you to customize and fit your site's unique needs. Please keep this in mind when requesting features and/or submitting pull requests. If it's not something that most people will use, I probably won't consider it. When in doubt ask.
|
88
|
-
|
89
|
-
This goes for author sidebar links and "share button" additions -- I have no intention of merging in every possibly option, the essentials are there to get you started :smile:.
|
90
|
-
|
91
|
-
### Pull Requests
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
- [
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
- [
|
128
|
-
- [
|
129
|
-
-
|
130
|
-
- [
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
copies
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
1
|
+
# [Minimal Mistakes Jekyll Theme](https://mmistakes.github.io/minimal-mistakes/)
|
2
|
+
|
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)
|
4
|
+
|
5
|
+
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:.
|
6
|
+
|
7
|
+
See what's new in the [CHANGELOG](CHANGELOG.md).
|
8
|
+
|
9
|
+
:sparkles: Minimal Mistakes is now available as a [Ruby gem](https://rubygems.org/gems/minimal-mistakes-jekyll). Consult the [Quick-Start Guide](https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/) and [this blog post](https://mmistakes.github.io/minimal-mistakes/jekyll/gemified-theme-beta/) to learn how to upgrade.
|
10
|
+
|
11
|
+
[![Minimal Mistakes live preview][2]][1]
|
12
|
+
|
13
|
+
[1]: https://mmistakes.github.io/minimal-mistakes/
|
14
|
+
[2]: screenshot.png (live preview)
|
15
|
+
|
16
|
+
![layout examples](screenshot-layouts.png)
|
17
|
+
|
18
|
+
## Notable Features
|
19
|
+
|
20
|
+
- "Gemified" for easier install/upgrading
|
21
|
+
- Compatible with Jekyll 3.x and GitHub Pages
|
22
|
+
- Support for Jekyll's built-in Sass/SCSS preprocessor
|
23
|
+
- Several responsive layout options (single, archive index, splash, and paginated home page)
|
24
|
+
- SEO optimized with support for [Twitter Cards](https://dev.twitter.com/cards/overview) and [Open Graph](http://ogp.me/) data
|
25
|
+
- 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.
|
26
|
+
- 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](https://staticman.net/), and custom).
|
27
|
+
- [Google Analytics](https://www.google.com/analytics/) support.
|
28
|
+
- UI localized text in English (default), Brazilian Portuguese, Chinese, French, German, Italian, Korean, Nepali (Nepalese), Russian, Spanish, and Turkish
|
29
|
+
|
30
|
+
## Demo Pages
|
31
|
+
|
32
|
+
| Name | Description |
|
33
|
+
| ------------------------------------------- | ----------------------------------------------------- |
|
34
|
+
| [Post with Header Image][header-image-post] | A post with a large header image. |
|
35
|
+
| [HTML Tags and Formatting Post][html-tags-post] | A variety of common markup showing how the theme styles them. |
|
36
|
+
| [Syntax Highlighting Post][syntax-post] | Post displaying highlighted code. |
|
37
|
+
| [Post with a Gallery][gallery-post] | A post showing several images wrapped in `<figure>` elements. |
|
38
|
+
| [Sample Collection Page][sample-collection] | Single page from a collection. |
|
39
|
+
| [Categories Archive][categories-archive] | Posts grouped by category. |
|
40
|
+
| [Tags Archive][tags-archive] | Posts grouped by tags. |
|
41
|
+
|
42
|
+
Additional sample posts are available under [posts archive][year-archive] on the demo site. Source files for these (and the entire demo site) can be found in [`/docs`](docs).
|
43
|
+
|
44
|
+
[header-image-post]: https://mmistakes.github.io/minimal-mistakes/layout-header-image-text-readability/
|
45
|
+
[gallery-post]: https://mmistakes.github.io/minimal-mistakes/post%20formats/post-gallery/
|
46
|
+
[html-tags-post]: https://mmistakes.github.io/minimal-mistakes/markup/markup-html-tags-and-formatting/
|
47
|
+
[syntax-post]: https://mmistakes.github.io/minimal-mistakes/markup-syntax-highlighting/
|
48
|
+
[sample-collection]: https://mmistakes.github.io/minimal-mistakes/recipes/chocolate-chip-cookies/
|
49
|
+
[categories-archive]: https://mmistakes.github.io/minimal-mistakes/categories/
|
50
|
+
[tags-archive]: https://mmistakes.github.io/minimal-mistakes/tags/
|
51
|
+
[year-archive]: https://mmistakes.github.io/minimal-mistakes/year-archive/
|
52
|
+
|
53
|
+
## Usage
|
54
|
+
|
55
|
+
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/).
|
56
|
+
|
57
|
+
**Note:** Gem version of the theme requires Jekyll v3.3+ and is not currently supported on [GitHub Pages](https://pages.github.com/). You can still use the theme with GitHub Pages, you'll just need to install using the old "[repo fork method](https://mmistakes.github.io/minimal-mistakes/docs/installation/)".
|
58
|
+
|
59
|
+
## Quick Start
|
60
|
+
|
61
|
+
Add this line to your Jekyll site's `Gemfile`:
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
gem "minimal-mistakes-jekyll"
|
65
|
+
```
|
66
|
+
|
67
|
+
Add this line to your Jekyll site's `_config.yml` file:
|
68
|
+
|
69
|
+
```yaml
|
70
|
+
theme: minimal-mistakes-jekyll
|
71
|
+
```
|
72
|
+
|
73
|
+
Then run Bundler to install the theme gem and dependencies:
|
74
|
+
|
75
|
+
```bash
|
76
|
+
bundle install
|
77
|
+
```
|
78
|
+
|
79
|
+
To update the theme run `bundle update`.
|
80
|
+
|
81
|
+
---
|
82
|
+
|
83
|
+
## Contributing
|
84
|
+
|
85
|
+
Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or [fixing a bug](https://github.com/mmistakes/minimal-mistakes/issues)? Then by all means [submit an issue](https://github.com/mmistakes/minimal-mistakes/issues/new) or [pull request](https://help.github.com/articles/using-pull-requests/). If this is your first pull request, it may be helpful to read up on the [GitHub Flow](https://guides.github.com/introduction/flow/) first.
|
86
|
+
|
87
|
+
Minimal Mistakes has been designed as a base for you to customize and fit your site's unique needs. Please keep this in mind when requesting features and/or submitting pull requests. If it's not something that most people will use, I probably won't consider it. When in doubt ask.
|
88
|
+
|
89
|
+
This goes for author sidebar links and "share button" additions -- I have no intention of merging in every possibly option, the essentials are there to get you started :smile:.
|
90
|
+
|
91
|
+
### Pull Requests
|
92
|
+
|
93
|
+
When submitting a pull request:
|
94
|
+
|
95
|
+
1. Clone the repo.
|
96
|
+
2. Create a branch off of `master` and give it a meaningful name (e.g. `my-awesome-new-feature`) and describe the feature or fix.
|
97
|
+
3. Open a pull request on GitHub.
|
98
|
+
|
99
|
+
Theme documentation and demo pages can be found in the [`/docs`](docs) if submitting improvements, typo corrections, etc.
|
100
|
+
|
101
|
+
## Development
|
102
|
+
|
103
|
+
To set up your environment to develop this theme, run `bundle install`.
|
104
|
+
|
105
|
+
To test the theme, run `bundle exec rake preview` and open your browser at `http://localhost:4000/test/`. This starts a Jekyll server using content in the `test/` directory. As modifications are made to the theme and test site, it will regenerate and you should see the changes in the browser after a refresh.
|
106
|
+
|
107
|
+
---
|
108
|
+
|
109
|
+
## Credits
|
110
|
+
|
111
|
+
### Creator
|
112
|
+
|
113
|
+
**Michael Rose**
|
114
|
+
|
115
|
+
- <https://mademistakes.com>
|
116
|
+
- <https://twitter.com/mmistakes>
|
117
|
+
- <https://github.com/mmistakes>
|
118
|
+
|
119
|
+
### Icons + Demo Images:
|
120
|
+
|
121
|
+
- [The Noun Project](https://thenounproject.com) -- Garrett Knoll, Arthur Shlain, and [tracy tam](https://thenounproject.com/tracytam)
|
122
|
+
- [Font Awesome](http://fortawesome.github.io/Font-Awesome/)
|
123
|
+
- [Unsplash](https://unsplash.com/)
|
124
|
+
|
125
|
+
### Other:
|
126
|
+
|
127
|
+
- [Jekyll](http://jekyllrb.com/)
|
128
|
+
- [jQuery](http://jquery.com/)
|
129
|
+
- [Susy](http://susy.oddbird.net/)
|
130
|
+
- [Breakpoint](http://breakpoint-sass.com/)
|
131
|
+
- [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/)
|
132
|
+
- [FitVids.JS](http://fitvidsjs.com/)
|
133
|
+
- Greedy Navigation - [lukejacksonn](http://codepen.io/lukejacksonn/pen/PwmwWV)
|
134
|
+
- [jQuery Smooth Scroll](https://github.com/kswedberg/jquery-smooth-scroll)
|
135
|
+
|
136
|
+
---
|
137
|
+
|
138
|
+
## License
|
139
|
+
|
140
|
+
The MIT License (MIT)
|
141
|
+
|
142
|
+
Copyright (c) 2017 Michael Rose
|
143
|
+
|
144
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
145
|
+
of this software and associated documentation files (the "Software"), to deal
|
146
|
+
in the Software without restriction, including without limitation the rights
|
147
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
148
|
+
copies of the Software, and to permit persons to whom the Software is
|
149
|
+
furnished to do so, subject to the following conditions:
|
150
|
+
|
151
|
+
The above copyright notice and this permission notice shall be included in all
|
152
|
+
copies or substantial portions of the Software.
|
153
|
+
|
154
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
155
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
156
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
157
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
158
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
159
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
160
|
+
SOFTWARE.
|
data/_layouts/default.html
CHANGED
@@ -1,34 +1,34 @@
|
|
1
|
-
---
|
2
|
-
---
|
3
|
-
|
4
|
-
<!doctype html>
|
5
|
-
<!--
|
6
|
-
Minimal Mistakes Jekyll Theme 4.
|
7
|
-
Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
|
8
|
-
Free for personal and commercial use under the MIT license
|
9
|
-
https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE.txt
|
10
|
-
-->
|
11
|
-
<html lang="{{ site.locale | slice: 0,2 | default: "en" }}" class="no-js">
|
12
|
-
<head>
|
13
|
-
{% include head.html %}
|
14
|
-
{% include head/custom.html %}
|
15
|
-
</head>
|
16
|
-
|
17
|
-
<body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %}">
|
18
|
-
|
19
|
-
{% include browser-upgrade.html %}
|
20
|
-
{% include masthead.html %}
|
21
|
-
|
22
|
-
{{ content }}
|
23
|
-
|
24
|
-
<div class="page__footer">
|
25
|
-
<footer>
|
26
|
-
{% include footer/custom.html %}
|
27
|
-
{% include footer.html %}
|
28
|
-
</footer>
|
29
|
-
</div>
|
30
|
-
|
31
|
-
{% include scripts.html %}
|
32
|
-
|
33
|
-
</body>
|
34
|
-
</html>
|
1
|
+
---
|
2
|
+
---
|
3
|
+
|
4
|
+
<!doctype html>
|
5
|
+
<!--
|
6
|
+
Minimal Mistakes Jekyll Theme 4.4.0 by Michael Rose
|
7
|
+
Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
|
8
|
+
Free for personal and commercial use under the MIT license
|
9
|
+
https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE.txt
|
10
|
+
-->
|
11
|
+
<html lang="{{ site.locale | slice: 0,2 | default: "en" }}" class="no-js">
|
12
|
+
<head>
|
13
|
+
{% include head.html %}
|
14
|
+
{% include head/custom.html %}
|
15
|
+
</head>
|
16
|
+
|
17
|
+
<body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %}">
|
18
|
+
|
19
|
+
{% include browser-upgrade.html %}
|
20
|
+
{% include masthead.html %}
|
21
|
+
|
22
|
+
{{ content }}
|
23
|
+
|
24
|
+
<div class="page__footer">
|
25
|
+
<footer>
|
26
|
+
{% include footer/custom.html %}
|
27
|
+
{% include footer.html %}
|
28
|
+
</footer>
|
29
|
+
</div>
|
30
|
+
|
31
|
+
{% include scripts.html %}
|
32
|
+
|
33
|
+
</body>
|
34
|
+
</html>
|
data/_layouts/single.html
CHANGED
@@ -21,7 +21,7 @@ layout: default
|
|
21
21
|
{% if page.title %}<meta itemprop="headline" content="{{ page.title | markdownify | strip_html | strip_newlines | escape_once }}">{% endif %}
|
22
22
|
{% if page.excerpt %}<meta itemprop="description" content="{{ page.excerpt | markdownify | strip_html | strip_newlines | escape_once }}">{% endif %}
|
23
23
|
{% if page.date %}<meta itemprop="datePublished" content="{{ page.date | date: "%B %d, %Y" }}">{% endif %}
|
24
|
-
{% if page.
|
24
|
+
{% if page.last_modified_at %}<meta itemprop="dateModified" content="{{ page.last_modified_at | date: "%B %d, %Y" }}">{% endif %}
|
25
25
|
|
26
26
|
<div class="page__inner-wrap">
|
27
27
|
{% unless page.header.overlay_color or page.header.overlay_image %}
|
@@ -43,8 +43,8 @@ layout: default
|
|
43
43
|
<h4 class="page__meta-title">{{ site.data.ui-text[site.locale].meta_label }}</h4>
|
44
44
|
{% endif %}
|
45
45
|
{% include page__taxonomy.html %}
|
46
|
-
{% if page.
|
47
|
-
<p class="page__date"><strong><i class="fa fa-fw fa-calendar" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}</strong> <time datetime="{{ page.
|
46
|
+
{% if page.last_modified_at %}
|
47
|
+
<p class="page__date"><strong><i class="fa fa-fw fa-calendar" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}</strong> <time datetime="{{ page.last_modified_at | date: "%Y-%m-%d" }}">{{ page.last_modified_at | date: "%B %d, %Y" }}</time></p>
|
48
48
|
{% elsif page.date %}
|
49
49
|
<p class="page__date"><strong><i class="fa fa-fw fa-calendar" aria-hidden="true"></i> {{ site.data.ui-text[site.locale].date_label | default: "Updated:" }}</strong> <time datetime="{{ page.date | date_to_xmlschema }}">{{ page.date | date: "%B %d, %Y" }}</time></p>
|
50
50
|
{% endif %}
|
data/_layouts/splash.html
CHANGED
@@ -13,7 +13,7 @@ layout: default
|
|
13
13
|
{% if page.title %}<meta itemprop="headline" content="{{ page.title | markdownify | strip_html | strip_newlines | escape_once }}">{% endif %}
|
14
14
|
{% if page.excerpt %}<meta itemprop="description" content="{{ page.excerpt | markdownify | strip_html | strip_newlines | escape_once }}">{% endif %}
|
15
15
|
{% if page.date %}<meta itemprop="datePublished" content="{{ page.date | date: "%B %d, %Y" }}">{% endif %}
|
16
|
-
{% if page.
|
16
|
+
{% if page.last_modified_at %}<meta itemprop="dateModified" content="{{ page.last_modified_at | date: "%B %d, %Y" }}">{% endif %}
|
17
17
|
|
18
18
|
<section class="page__content" itemprop="text">
|
19
19
|
{{ content }}
|