Skip to content

Commit f0d24a5

Browse files
committed
Fix typos and grammar
1 parent dc5a28f commit f0d24a5

File tree

4 files changed

+63
-20
lines changed

4 files changed

+63
-20
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ See a [live version of Minimal Mistakes](http://mmistakes.github.io/minimal-mist
1818

1919
## Getting Started
2020

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.
2222

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.

_includes/_open-graph.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<meta name="twitter:image" content="{{ site.url }}/images/{{ page.image.feature }}">
99
{% else %}
1010
<meta name="twitter:card" content="summary">
11-
<meta name="twitter:image" content="{% if page.image.thumb %}{{ site.url }}/images/{{ page.image.thumb }}{% else %}{{ site.url }}/images/{{ site.logo }}{% endif %}">
11+
<meta name="twitter:image" content="{% if page.image.thumb %}{{ site.url }}/images/{{ page.image.thumb }}{% else %}{{ site.url }}/images/default-thumb.png{% endif %}">
1212
{% endif %}
1313
<!-- Open Graph -->
1414
<meta property="og:locale" content="{{ site.locale }}">

_posts/2014-07-31-author-override.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ excerpt: "A post to test author overrides using a data file."
77
tags: []
88
---
99

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.
1111

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`
1313

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.
1515

1616
{% highlight yaml %}
1717
# Authors
@@ -21,18 +21,22 @@ billy_rick:
2121
web: http://thewhip.com
2222
2323
bio: "What do you want, jewels? I am a very extravagant man."
24-
avatar: bio-photo.jpg
24+
avatar: bio-photo-2.jpg
2525
twitter: extravagantman
26+
google:
27+
plus: +BillyRick
2628

2729
cornelius_fiddlebone:
2830
name: Cornelius Fiddlebone
2931
3032
bio: "I ordered what?"
3133
avatar: bio-photo.jpg
3234
twitter: rhymeswithsackit
35+
google:
36+
plus: +CorneliusFiddlebone
3337
{% endhighlight %}
3438

35-
To assign Billy Rick as an author for our post. We'd add the following YAML front matter to a post:
39+
To assign Billy Rick as an author for our post. You'd add the following YAML front matter to a post:
3640

3741
{% highlight yaml %}
3842
author: billy_rick

theme-setup/index.md

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,17 @@ If you are creating a new Jekyll site using Minimal Mistakes follow these steps:
2727

2828
1. Fork the [Minimal Mistakes repo](http://github.com/mmistakes/minimal-mistakes/fork).
2929
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)
3131
4. Update `config.yml`, add navigation, and replace demo posts and pages with your own. Full details below.
3232

3333
If you want to use Minimal Mistakes with an existing Jekyll site follow these steps:
3434

3535
1. [Download Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes/archive/master.zip) and unzip.
3636
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.
4141

4242
**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.
4343
{: .notice}
@@ -66,6 +66,8 @@ minimal-mistakes/
6666
| └── post.html # single post layout
6767
├── _posts/ # MarkDown formatted posts
6868
├── _sass/ # Sass stylesheets
69+
├── _templates/ # used by Octopress to define YAML variables for new posts/pages
70+
├── about/ # sample about page
6971
├── assets/
7072
| ├── css/ # compiled stylesheets
7173
| ├── fonts/ # webfonts
@@ -77,11 +79,10 @@ minimal-mistakes/
7779
| └── less/
7880
├── images/ # images for posts and pages
7981
├── 404.md # 404 page
80-
├── about.md # sample about page
8182
├── feed.xml # Atom feed template
8283
├── index.md # sample homepage. lists 5 latest posts
83-
├── 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
8586
{% endhighlight %}
8687

8788
---
@@ -102,7 +103,7 @@ Example `title: My Awesome Site`
102103

103104
#### url
104105

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 `/`*.
106107

107108
Examples:
108109

@@ -211,7 +212,45 @@ image:
211212

212213
### Thumbnails for OG and Twitter Cards
213214

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.
225+
226+
{% highlight yaml %}
227+
# Authors
228+
229+
billy_rick:
230+
name: Billy Rick
231+
web: http://thewhip.com
232+
233+
bio: "What do you want, jewels? I am a very extravagant man."
234+
avatar: bio-photo-2.jpg
235+
twitter: extravagantman
236+
google:
237+
plus: +BillyRick
238+
239+
cornelius_fiddlebone:
240+
name: Cornelius Fiddlebone
241+
242+
bio: "I ordered what?"
243+
avatar: bio-photo.jpg
244+
twitter: rhymeswithsackit
245+
google:
246+
plus: +CorneliusFiddlebone
247+
{% endhighlight %}
248+
249+
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 %}
215254

216255
### Table of Contents
217256

@@ -246,7 +285,7 @@ Not sure if this only effects Kramdown or if it's an issue with Markdown in gene
246285

247286
## Further Customization
248287

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.
250289

251290
For example if you wanted a red background instead of white you'd change `$bodycolor: #fff;` to `$bodycolor: $cc0033;`.
252291

@@ -256,7 +295,7 @@ To modify the site's JavaScript files I setup a Grunt build script to lint/conca
256295
npm install
257296
{% endhighlight %}
258297

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.
260299

261300
---
262301

0 commit comments

Comments
 (0)