N-archive/hacks-guide-minimal-mistakes-theme
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add GitHub repo URL

Browse source
This commit is contained in:
Michael Rose 2016-04-12 14:34:36 -04:00
parent a4ff482323
commit 29a47da3f2
6 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
_config.yml
View file

@ -13,6 +13,7 @@ name : &name "Michael Rose"
description : &description "A flexible Jekyll theme for your blog or site with a minimalist aesthetic."
url : # the base hostname & protocol for your site e.g. "//github.io.mmistakes"
baseurl : "/minimal-mistakes" # the subpath of your site, e.g. "/blog"
gh_repo : "https://github.com/mmistakes/minimal-mistakes"
teaser : # filename of teaser fallback teaser image placed in /images/, .e.g. "500x300.png"
breadcrumbs : true # true, false (default)
words_per_minute : 200

2
_docs/01-quick-start-guide.md
View file

@ -15,7 +15,7 @@ Minimal Mistakes has been developed to be 100% compatible with hosting a site on
## Fork the Theme
Fork the [Minimal Mistakes theme](https://github.com/mmistakes/minimal-mistakes/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
Fork the [Minimal Mistakes theme]({{ site.gh_repo }}/fork), then rename the repo to **USERNAME.github.io** --- replacing **USERNAME** with your GitHub username.
<figure>
<img src="{{ base_path }}/images/mm-theme-fork-repo.png" alt="fork Minimal Mistakes">

4
_docs/03-installation.md
View file

@ -24,7 +24,7 @@ There are several ways to install the theme:
**3.** And for those who don't want to mess with Git, you can download the theme as a ZIP file to work with locally.
[<i class="fa fa-download"></i> Download Minimal Mistakes Theme](https://github.com/mmistakes/minimal-mistakes/archive/master.zip){: .btn .btn--success}
[<i class="fa fa-download"></i> Download Minimal Mistakes Theme]({{ site.gh_repo }}/archive/master.zip){: .btn .btn--success}
**ProTip:** Be sure to [delete](https://github.com/blog/1377-create-and-delete-branches) the `gh-pages` branch if you forked Minimal Mistakes. This branch contains the documentation and demo site for the theme and you probably don't want that showing up in your repo.
{: .notice--info}
@ -60,7 +60,7 @@ defaults:
If this is your first time using Jekyll be sure to read through the [official documentation](https://jekyllrb.com/docs/home/) to familiarize yourself. This guide assumes you've done that and have Jekyll v3 and Ruby v2 installed.
To keep your sanity and better manage dependencies I strongly urge you to [install Bundler](http://bundler.io/) with `gem install bundler` and use the included [`Gemfile`](https://github.com/mmistakes/minimal-mistakes/blob/master/Gemfile). Minimal Mistake's Gemfile defaults to the `github-pages` gem to maintain a local Jekyll environment in sync with GitHub Pages.
To keep your sanity and better manage dependencies I strongly urge you to [install Bundler](http://bundler.io/) with `gem install bundler` and use the included [`Gemfile`]({{ site.gh_repo }}/blob/master/Gemfile). Minimal Mistake's Gemfile defaults to the `github-pages` gem to maintain a local Jekyll environment in sync with GitHub Pages.
If you're not planning on hosting with GitHub Pages and want to leverage features found in the latest version of Jekyll replace `gem "github-pages"` with `gem "jekyll"` in your `Gemfile` and then run:

6
_docs/04-upgrading.md
View file

@ -15,12 +15,12 @@ Currently there is no good way of upgrading the theme without doing a bit of man
If you want to get the most out of the Jekyll + GitHub Pages workflow, then you'll need to utilize Git. To pull down theme updates you must first ensure there's an upstream remote. If you forked the Minimal Mistakes repo then you're likely good to go.
To double check, run `git remote -v` and verify that you can fetch from `origin https://github.com/mmistakes/minimal-mistakes.git`.
To double check, run `git remote -v` and verify that you can fetch from `origin {{ site.gh_repo }}/minimal-mistakes.git`.
To add it you can do the following:
```bash
$ git remote add upstream https://github.com/mmistakes/minimal-mistakes.git
$ git remote add upstream {{ site.gh_repo }}/minimal-mistakes.git
```
### Pull Down Updates
@ -35,7 +35,7 @@ Depending on the amount of customizations you've made after forking, there's lik
## Update Files Manually
The alternate way of dealing with updates is [downloading the theme](https://github.com/mmistakes/minimal-mistakes/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones. To be sure that you don't miss any changes it's probably a good idea to review the [history](https://github.com/mmistakes/minimal-mistakes/commits/master) to see what's changed since you last forked/cloned the theme.
The alternate way of dealing with updates is [downloading the theme]({{ site.gh_repo }}/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones. To be sure that you don't miss any changes it's probably a good idea to review the [history]({{ site.gh_repo }}/commits/master) to see what's changed since you last forked/cloned the theme.
Here's a quick checklist of the important folders/files you'll want to be mindful of:

4
_docs/05-configuration.md
View file

@ -397,7 +397,7 @@ defaults:
layout: single
```
And of course any default value can be overridden by settings in a post, page, or collection file. All you need to do is specify the settings in the YAML Front Matter. For more examples be sure to check out the demo site's [`_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_config.yml).
And of course any default value can be overridden by settings in a post, page, or collection file. All you need to do is specify the settings in the YAML Front Matter. For more examples be sure to check out the demo site's [`_config.yml`]({{ site.gh_repo }}/blob/gh-pages/_config.yml).
## Outputting
@ -461,7 +461,7 @@ tags:
Which would create category and tag links in the breadcrumbs and page meta like: `/categories/#foo` and `/tags/#foo`.
**Note:** for these links to resolve category and tag index pages need to exist at [`/categories/index.html`](https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_pages/category-archive.html) and [`/tags/index.html`](https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_pages/tag-archive.html). Examples with the necessary Liquid code can be taken from the demo site.
**Note:** for these links to resolve category and tag index pages need to exist at [`/categories/index.html`]({{ site.gh_repo }}/blob/gh-pages/_pages/category-archive.html) and [`/tags/index.html`]({{ site.gh_repo }}/blob/gh-pages/_pages/tag-archive.html). Examples with the necessary Liquid code can be taken from the demo site.
{: .notice--warning}
If you have the luxury of using Jekyll Plugins then [**jekyll-archives**][jekyll-archives] will make your life much easier as category and tag pages are created for you.

10
_docs/09-layouts.md
View file

@ -57,10 +57,10 @@ Below are sample archive pages you can easily drop into your project, taking car
* [All Posts Grouped by Year][posts-year]
* [All Posts Grouped by Collection][posts-collection]
[posts-categories]: https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_pages/category-archive.html
[posts-tags]: https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_pages/tag-archive.html
[posts-year]: https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_pages/year-archive.html
[posts-collection]: https://github.com/mmistakes/minimal-mistakes/blob/gh-pages/_pages/collection-archive.html
[posts-categories]: {{ site.gh_repo }}/blob/gh-pages/_pages/category-archive.html
[posts-tags]: {{ site.gh_repo }}/blob/gh-pages/_pages/tag-archive.html
[posts-year]: {{ site.gh_repo }}/blob/gh-pages/_pages/year-archive.html
[posts-collection]: {{ site.gh_repo }}/blob/gh-pages/_pages/collection-archive.html
### Taxonomy Archive
@ -70,7 +70,7 @@ If you have the luxury of using Jekyll plugins the creation of category and tag
### Home Page
Minimal Mistakes ships with an [`index.html`](https://github.com/mmistakes/minimal-mistakes/blob/master/index.html) in the root of the project for displaying the 5 most recent posts --- with pagination. It does this by assigning `layout: archive` in the YAML Front Matter and including the following Liquid in the body:
Minimal Mistakes ships with an [`index.html`]({{ site.gh_repo }}/blob/master/index.html) in the root of the project for displaying the 5 most recent posts --- with pagination. It does this by assigning `layout: archive` in the YAML Front Matter and including the following Liquid in the body:
```html
{% raw %}<!-- start index.html body -->