You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,6 @@ See a [live version of Minimal Mistakes](http://mmistakes.github.io/minimal-mist
18
18
19
19
## Getting Started
20
20
21
-
Minimal Mistakes takes advantage of Sass and data files to make customizing easier. These features require Jekyll 2+ and will not work with older versions of Jekyll.
21
+
Minimal Mistakes takes advantage of Sass and data files to make customizing easier. These features require Jekyll 2.x and will not work with older versions of Jekyll.
22
22
23
-
To learn more about how install and use this theme check out the [Setup Guide](http://mmistakes.github.io/minimal-mistakes/theme-setup/) for more information.
23
+
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.
Copy file name to clipboardExpand all lines: _posts/2014-07-31-author-override.md
+9-5Lines changed: 9 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,11 @@ excerpt: "A post to test author overrides using a data file."
7
7
tags: []
8
8
---
9
9
10
-
For those of you who may have content written by multiple authors on your site you can assign different authors to each post if desired.
10
+
For those of you who may have content written by multiple authors on your site you can now assign different authors to each post if desired.
11
11
12
-
Traditionally you would assign a global author for the entire site and those attributes would be used in all post bylines, social networking links in the footer, Twitter Cards, and Google Authorship. These `owner` variables defined in your`config.yml`
12
+
Previously the theme used a global author for the entire site and those attributes would be used in all bylines, social networking links, Twitter Card attribution, and Google Authorship. These `owner` variables were defined in `config.yml`
13
13
14
-
Start by creating an`authors.yml` file in the `_data` folder and add your authors using the following format.
14
+
Start by modifying or creating a new`authors.yml` file in the `_data` folder and add your authors using the following format.
Copy file name to clipboardExpand all lines: theme-setup/index.md
+51-12Lines changed: 51 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -27,17 +27,17 @@ If you are creating a new Jekyll site using Minimal Mistakes follow these steps:
27
27
28
28
1. Fork the [Minimal Mistakes repo](http://github.com/mmistakes/minimal-mistakes/fork).
29
29
2. Clone the repo you just forked and rename it.
30
-
3.[Install Bundler](http://bundler.io)`gem install bundler` and Run `bundle install` to install all dependencies (Jekyll, [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap), [Octopress](https://github.com/octopress/octopress), [Bourbon](http://bourbon.io), etc)
30
+
3.[Install Bundler](http://bundler.io)`gem install bundler` and Run `bundle install` to install all dependencies (Jekyll, [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap), [Octopress](https://github.com/octopress/octopress), etc)
31
31
4. Update `config.yml`, add navigation, and replace demo posts and pages with your own. Full details below.
32
32
33
33
If you want to use Minimal Mistakes with an existing Jekyll site follow these steps:
34
34
35
35
1.[Download Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes/archive/master.zip) and unzip.
36
36
2. Rename `minimal-mistakes-master` to something meaningful ie: `new-site`
37
-
3. Run `bundle install` to install all dependencies (Jekyll, [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap), [Octopress](https://github.com/octopress/octopress), [Bourbon](http://bourbon.io), etc)
38
-
4. Remove demo posts and pages add replace with your own posts, pages, and any other content you want to move over.
39
-
5. Update posts and pages YAML to match variables used by Minimal Mistakes. Full details below.
40
-
6. Update `config.yml` and add navigation links. Full details below.
37
+
3. Run `bundle install` to install all dependencies (Jekyll, [Jekyll-Sitemap](https://github.com/jekyll/jekyll-sitemap), [Octopress](https://github.com/octopress/octopress), etc)
38
+
4. Remove demo posts/pages and replace with your own posts, pages, and any other content you want to move over.
39
+
5. Update posts' and pages' YAML to match variables used by Minimal Mistakes. Full details below.
40
+
6. Update `_config.yml` and add navigation links. Full details below.
41
41
42
42
**Pro-tip:** Delete the `gh-pages` branch after cloning and start fresh by branching off `master`. There is a bunch of garbage in `gh-pages` used for the theme's demo site that I'm guessing you won't want.
43
43
{: .notice}
@@ -66,6 +66,8 @@ minimal-mistakes/
66
66
| └── post.html # single post layout
67
67
├── _posts/ # MarkDown formatted posts
68
68
├── _sass/ # Sass stylesheets
69
+
├── _templates/ # used by Octopress to define YAML variables for new posts/pages
├── posts.md # sample post index page. lists all posts in reverse chronology
84
-
└── theme-setup.md # theme setup page. safe to remove
84
+
├── posts/ # sample post index page. lists all posts in reverse chronology
85
+
└── theme-setup/ # theme setup page. safe to remove
85
86
{% endhighlight %}
86
87
87
88
---
@@ -102,7 +103,7 @@ Example `title: My Awesome Site`
102
103
103
104
#### url
104
105
105
-
Used to generate absolute urls in `sitemap.xml`, `atom.xml`, and for generating canonical URLs in `<head>`. When developing locally either comment this out or use something like `http://localhost:4000` so all assets load properly. *Don't include a trailing `/`*.
106
+
Used to generate absolute urls in `sitemap.xml`, `feed.xml`, and for generating canonical URLs in `<head>`. When developing locally either comment this out or use something like `http://localhost:4000` so all assets load properly. *Don't include a trailing `/`*.
106
107
107
108
Examples:
108
109
@@ -211,7 +212,45 @@ image:
211
212
212
213
### Thumbnails for OG and Twitter Cards
213
214
214
-
Post and page thumbnails work the same way. These are used by [Open Graph](https://developers.facebook.com/docs/opengraph/) and [Twitter Cards](https://dev.twitter.com/docs/cards) meta tags found in *_head.html*. If you don't assign a thumbnail the default graphic *(default-thumb.png)* is used. I'd suggest changing this to something more meaningful --- your logo or avatar are good options.
215
+
Feature and thumbnail images are used by [Open Graph](https://developers.facebook.com/docs/opengraph/) and [Twitter Cards](https://dev.twitter.com/docs/cards) as well. If you don't assign a thumbnail the default graphic *(default-thumb.png)* is used. I'd suggest changing this to something more meaningful --- your logo or avatar are good options.
216
+
217
+
**Pro-Tip**: You need to [apply for Twitter Cards](https://dev.twitter.com/docs/cards) before they will begin showing up when links to your site are shared.
218
+
{:.notice}
219
+
220
+
### Author Override
221
+
222
+
By making use of data files you can assign different authors for each post.
223
+
224
+
Start by modifying `authors.yml` file in the `_data` folder and add your authors using the following format.
To assign Billy Rick as an author for our post. We'd add the following YAML front matter to a post:
250
+
251
+
{% highlight yaml %}
252
+
author: billy_rick
253
+
{% endhighlight %}
215
254
216
255
### Table of Contents
217
256
@@ -246,7 +285,7 @@ Not sure if this only effects Kramdown or if it's an issue with Markdown in gene
246
285
247
286
## Further Customization
248
287
249
-
Jekyll 2.0 added support for Sass files making it much easier to modify a theme's fonts and colors. By editing values found in `_sass/variables.scss` you can fine tune the site's colors and typography.
288
+
Jekyll 2.x added support for Sass files making it much easier to modify a theme's fonts and colors. By editing values found in `_sass/variables.scss` you can fine tune the site's colors and typography.
250
289
251
290
For example if you wanted a red background instead of white you'd change `$bodycolor: #fff;` to `$bodycolor: $cc0033;`.
252
291
@@ -256,7 +295,7 @@ To modify the site's JavaScript files I setup a Grunt build script to lint/conca
256
295
npm install
257
296
{% endhighlight %}
258
297
259
-
From the theme's root, use `grunt` concatenate JavaScript files, and optimize .jpg, .png, and .svg files in the `images/` folder. You can also use `grunt watch` in combination with `jekyll build --watch` to watch for updates JS files that Grunt will then automatically re-build as you write your code which will in turn auto-generate your Jekyll site when developing locally.
298
+
From the theme's root, use `grunt` concatenate JavaScript files, and optimize .jpg, .png, and .svg files in the `images/` folder. You can also use `grunt dev` in combination with `jekyll build --watch` to watch for updates JS files that Grunt will then automatically re-build as you write your code which will in turn auto-generate your Jekyll site when developing locally.
0 commit comments