Glavo/minimal-mistakes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix {{ site.gh_repo }} links

Browse Source
This commit is contained in:
Michael Rose 2016-08-01 09:33:32 -04:00
parent a04674dccd
commit 890a5e3eb2
8 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_docs/03-installation.md
View File

@ -58,7 +58,7 @@ defaults:
If this is your first time using Jekyll be sure to read through the [official documentation](https://jekyllrb.com/docs/home/) before jumping in. This guide assumes you have Ruby v2 installed and a basic understanding of how Jekyll works.
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). The theme's Gemfile includes 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`](https://github.com/{{ site.repository }}/blob/master/Gemfile). The theme's Gemfile includes 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`. In either case run the following:

6
_docs/04-upgrading.md
View File

@ -13,12 +13,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 theme's repo then you're likely good to go.
To double check, run `git remote -v` and verify that you can fetch from `origin {{ site.gh_repo }}/minimal-mistakes.git`.
To double check, run `git remote -v` and verify that you can fetch from `origin https://github.com/{{ site.repository }}.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 https://github.com/{{ site.repository }}.git
```
### Pull Down Updates
@ -33,7 +33,7 @@ Depending on the amount of customizations you've made after forking, there's lik
## Update Files Manually
Another 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 manually. To be sure that you don't miss any changes it's probably a good idea to review the theme's [commit history]({{ site.gh_repo }}/commits/master) to see what's changed since.
Another way of dealing with updates is [downloading the theme](https://github.com/{{ site.repository }}/archive/master.zip) --- replacing your layouts, includes, and assets with the newer ones manually. To be sure that you don't miss any changes it's probably a good idea to review the theme's [commit history](https://github.com/{{ site.repository }}/commits/master) to see what's changed since.
Here's a quick checklist of the important folders/files you'll want to be mindful of:

6
_docs/05-configuration.md
View File

@ -205,7 +205,7 @@ atom_feed:
path: "http://feeds.feedburner.com/youFeedname"
```
**Note:** By default the site feed is linked in two locations: inside the [`<head>` element]({{ gh_repo }}/master/_includes/head.html) and at the bottom of every page in the [site footer]({{ gh_repo }}/master/_includes/footer.html).
**Note:** By default the site feed is linked in two locations: inside the [`<head>` element]({{ gh_repo }}/master/_includes/head.html) and at the bottom of every page in the [site footer](https://github.com/{{ site.repository }}/master/_includes/footer.html).
{: .notice--info}
### SEO, Social Sharing, and Analytics Settings
@ -429,7 +429,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`]({{ site.gh_repo }}/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`](https://github.com/{{ site.repository }}/gh-pages/_config.yml).
## Outputting
@ -498,7 +498,7 @@ tag_archive:
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 properly, category and tag index pages need to exist at [`/categories/index.html`]({{ site.gh_repo }}/gh-pages/_pages/category-archive.html) and [`/tags/index.html`]({{ site.gh_repo }}/gh-pages/_pages/tag-archive.html). The necessary Liquid code to build these pages can be taken from the demo site.
**Note:** for these links to resolve properly, category and tag index pages need to exist at [`/categories/index.html`](https://github.com/{{ site.repository }}/gh-pages/_pages/category-archive.html) and [`/tags/index.html`](https://github.com/{{ site.repository }}/gh-pages/_pages/tag-archive.html). The necessary Liquid code to build these pages 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.

14
_docs/09-layouts.md
View File

@ -73,11 +73,11 @@ Below are sample archive pages you can easily drop into your project, taking car
* [All Posts Grouped by Collection -- List View][posts-collection]
* [Portfolio Collection -- Grid View][portfolio-collection]
[posts-categories]: {{ site.gh_repo }}/gh-pages/_pages/category-archive.html
[posts-tags]: {{ site.gh_repo }}/gh-pages/_pages/tag-archive.html
[posts-year]: {{ site.gh_repo }}/gh-pages/_pages/year-archive.html
[posts-collection]: {{ site.gh_repo }}/gh-pages/_pages/collection-archive.html
[portfolio-collection]: {{ site.gh_repo }}/gh-pages/_pages/portfolio-archive.html
[posts-categories]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/category-archive.html
[posts-tags]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/tag-archive.html
[posts-year]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/year-archive.html
[posts-collection]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/collection-archive.html
[portfolio-collection]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/portfolio-archive.html
Post and page excerpts are auto-generated by Jekyll which grabs the first paragraph of text. To override this text with something more specific use the following YAML Front Matter:
@ -130,7 +130,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`]({{ site.gh_repo }}/master/index.html) in the root of the project for displaying recent posts.
Minimal Mistakes ships with an [`index.html`](https://github.com/{{ site.repository }}/blob/master/index.html) in the root of the project for displaying recent posts.
**Includes:**
@ -174,7 +174,7 @@ For full-width landing pages that need a little something extra add `layout: spl
![splash page layout example]({{ base_path }}/images/mm-layout-splash.png)
Feature blocks can be assigned and aligned to the `left`, `right`, or `center` with a sprinkling of YAML. For full details on how to use the `feature_row` helper check the [**Content**]({{ base_path }}/docs/helpers/) section or review a [sample splash page]({{ site.gh_repo }}/gh-pages/_pages/splash-page.md).
Feature blocks can be assigned and aligned to the `left`, `right`, or `center` with a sprinkling of YAML. For full details on how to use the `feature_row` helper check the [**Content**]({{ base_path }}/docs/helpers/) section or review a [sample splash page](https://github.com/{{ site.repository }}/blob/gh-pages/_pages/splash-page.md).
---

4
_docs/12-collections.md
View File

@ -11,7 +11,7 @@ Collections like posts and pages work as you'd expect. If you're new to them be
The theme has been built with collections in mind and you will find [several examples]({{ base_path }}/collection-archive/) on the demo site ([portfolio]({{ base_path }}/portfolio/), [recipes]({{ base_path }}/recipes/), pets).
**Collections in the Wild:** This set of documentation is also [built as a collection]({{ site.gh_repo }}/gh-pages/_docs/) if you're looking for a fully fleshed out example to inspect.
**Collections in the Wild:** This set of documentation is also [built as a collection](https://github.com/{{ site.repository }}/blob/gh-pages/_docs/) if you're looking for a fully fleshed out example to inspect.
{: .notice--info}
---
@ -43,6 +43,6 @@ defaults:
share: true
```
And then create portfolio content like [`_portfolio/foo-bar-website.md`]({{ site.gh_repo }}/gh-pages/_portfolio/foo-bar-website.md), to end up with something like this.
And then create portfolio content like [`_portfolio/foo-bar-website.md`](https://github.com/{{ site.repository }}/blob/gh-pages/_portfolio/foo-bar-website.md), to end up with something like this.
![portfolio collection example]({{ base_path }}/images/mm-portfolio-collection-example.jpg)

10
_docs/13-helpers.md
View File

@ -58,9 +58,9 @@ The Liquid based taxonomy archives found amongst the demo pages rely on this hel
| All posts grouped by category | [Source][category-array] | [Demo][category-array-demo] |
| All posts grouped by tags | [Source][tag-array] | [Demo][tag-array-demo] |
[category-array]: {{ site.gh_repo }}/gh-pages/_pages/category-archive.html
[category-array]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/category-archive.html
[category-array-demo]: {{ base_path }}/categories/
[tag-array]: {{ site.gh_repo }}/gh-pages/_pages/tag-archive.html
[tag-array]: https://github.com/{{ site.repository }}/blob/gh-pages/_pages/tag-archive.html
[tag-array-demo]: {{ base_path }}/tags/
## Gallery
@ -108,7 +108,7 @@ And then drop-in the gallery include in the body where you'd like it to appear.
{% include gallery caption="This is a sample gallery with **Markdown support**." %}
**More Gallery Goodness:** A few more examples and [source code]({{ site.gh_repo }}/gh-pages/_posts/2010-09-09-post-gallery.md) can be seen in [this sample gallery post]({{ base_path }}{% post_url 2010-09-09-post-gallery %}).
**More Gallery Goodness:** A few more examples and [source code](https://github.com/{{ site.repository }}/blob/gh-pages/_posts/2010-09-09-post-gallery.md) can be seen in [this sample gallery post]({{ base_path }}{% post_url 2010-09-09-post-gallery %}).
{: .notice--info}
## Feature Row
@ -158,7 +158,7 @@ And then drop-in the feature row include in the body where you'd like it to appe
{% include feature_row %}
**More Feature Row Goodness:** A [few more examples]({{ base_path }}/splash-page/) and [source code]({{ site.gh_repo }}/gh-pages/_pages/splash-page.md) can be seen in the demo site.
**More Feature Row Goodness:** A [few more examples]({{ base_path }}/splash-page/) and [source code](https://github.com/{{ site.repository }}/blob/gh-pages/_pages/splash-page.md) can be seen in the demo site.
{: .notice--info}
## Table of Contents
@ -240,7 +240,7 @@ sidebar:
**ProTip:** If you're applying the same navigation list to several pages setting it as a [Front Matter default](https://jekyllrb.com/docs/configuration/#front-matter-defaults) is the better option.
{: .notice--info}
The theme's documentation is built with the `nav_list` helper so if you'd like an example to dissect take a look at `navigation.yml`, `_config.yml` and `_doc/` in the [`gh-pages` branch]({{ site.gh_repo }}/gh-pages/) of this repo.
The theme's documentation is built with the `nav_list` helper so if you'd like an example to dissect take a look at `navigation.yml`, `_config.yml` and `_doc/` in the [`gh-pages` branch](https://github.com/{{ site.repository }}/tree/gh-pages/) of this repo.
To add a navigation list to a post or page's main content instead of the sidebar use the include this way:

2
_docs/15-stylesheets.md
View File

@ -158,7 +158,7 @@ To get started:
2. `cd` to the root of your project.
3. Install all of the dependencies by running `npm install`.
**Note:** If you upgraded from a previous version of the theme be sure you copied over [`package.json`]({{ site.gh_repo }}/master/package.json) prior to running `npm install`.
**Note:** If you upgraded from a previous version of the theme be sure you copied over [`package.json`](https://github.com/{{ site.repository }}/blob/master/package.json) prior to running `npm install`.
{: .notice--warning}
If all goes well, running `npm run build:css` will process all SCSS files into `main.css`, which should then pipe through Autoprefixer.

2
_docs/16-javascript.md
View File

@ -44,7 +44,7 @@ To get started:
2. `cd` to the root of your project.
3. Install all of the dependencies by running `npm install`.
**Note:** If you upgraded from a previous version of the theme be sure you copied over [`package.json`]({{ site.gh_repo }}/master/package.json) prior to running `npm install`.
**Note:** If you upgraded from a previous version of the theme be sure you copied over [`package.json`](https://github.com/{{ site.repository }}/blob/master/package.json) prior to running `npm install`.
{: .notice--warning}
If all goes well, running `npm run build:js` will compress/concatenate `_main.js` and all plugin scripts into `main.min.js`.