Replace absolute_url with relative_url
This commit is contained in:
Michael Rose
parent
a76c16ee23
commit
4d4531d19f
|
|
@ -2,7 +2,7 @@
|
|||
title: "Quick-Start Guide"
|
||||
permalink: /docs/quick-start-guide/
|
||||
excerpt: "How to quickly install and setup Minimal Mistakes for use with GitHub Pages."
|
||||
last_modified_at: 2018-01-02T16:28:04-05:00
|
||||
last_modified_at: 2018-03-20T15:58:49-04:00
|
||||
redirect_from:
|
||||
- /theme-setup/
|
||||
toc: true
|
||||
|
|
@ -14,7 +14,7 @@ Minimal Mistakes has been developed as a [Jekyll theme gem](http://jekyllrb.com/
|
|||
|
||||
If you're running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem.
|
||||
|
||||
[^structure]: See [**Structure** page]({{ "/docs/structure/" | absolute_url }}) for a list of theme files and what they do.
|
||||
[^structure]: See [**Structure** page]({{ "/docs/structure/" | relative_url }}) for a list of theme files and what they do.
|
||||
|
||||
**ProTip:** Be sure to remove `/docs` and `/test` if you forked Minimal Mistakes. These folders contain documentation and test pages for the theme and you probably don't want them littering up your repo.
|
||||
{: .notice--info}
|
||||
|
|
@ -63,7 +63,7 @@ You may also optionally specify a branch, [tag](https://github.com/mmistakes/min
|
|||
If you're hosting several Jekyll based sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than **USERNAME.github.io** and create a `gh-pages` branch off of `master`. For more details on how to set things up check [GitHub's documentation](https://help.github.com/articles/user-organization-and-project-pages/).
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-gh-pages.gif' | absolute_url }}" alt="creating a new branch on GitHub">
|
||||
<img src="{{ '/assets/images/mm-gh-pages.gif' | relative_url }}" alt="creating a new branch on GitHub">
|
||||
</figure>
|
||||
|
||||
You can also install the theme by copying all of the theme files[^structure] into your project.
|
||||
|
|
@ -71,7 +71,7 @@ You can also install the theme by copying all of the theme files[^structure] int
|
|||
To do so 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.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-theme-fork-repo.png' | absolute_url }}" alt="fork Minimal Mistakes">
|
||||
<img src="{{ '/assets/images/mm-theme-fork-repo.png' | relative_url }}" alt="fork Minimal Mistakes">
|
||||
</figure>
|
||||
|
||||
**GitHub Pages Alternatives:** Looking to host your site for free and install/update the theme painlessly? [Netflify][netlify-jekyll], [GitLab Pages][gitlab-jekyll], and [Continuous Integration (CI) services][ci-jekyll] have you covered. In most cases all you need to do is connect your repository to them, create a simple configuration file, and install the theme following the [Ruby Gem Method](#ruby-gem-method) above.
|
||||
|
|
@ -105,15 +105,15 @@ Depending on the path you took installing Minimal Mistakes you'll setup things a
|
|||
|
||||
### Starting Fresh
|
||||
|
||||
Starting with an empty folder and `Gemfile` you'll need to copy or re-create this [default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml) file. For a full explanation of every setting be sure to read the [**Configuration**]({{ "/docs/configuration/" | absolute_url }}) section.
|
||||
Starting with an empty folder and `Gemfile` you'll need to copy or re-create this [default `_config.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_config.yml) file. For a full explanation of every setting be sure to read the [**Configuration**]({{ "/docs/configuration/" | relative_url }}) section.
|
||||
|
||||
From `v4.5.0` onwards, Minimal Mistakes theme-gem comes bundled with the necessary data files and will automatically use them via the [`jekyll-data`](https://github.com/ashmaroli/jekyll-data) plugin. So you no longer need to maintain a copy of these data files at your project directory.
|
||||
|
||||
However like all other bundled files, you'll need to create and edit these data files to customize them.
|
||||
The bundled data files are:
|
||||
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | absolute_url }})
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | relative_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | relative_url }})
|
||||
|
||||
### Starting from `jekyll new`
|
||||
|
||||
|
|
@ -121,7 +121,7 @@ Scaffolding out a site with the `jekyll new` command requires you to modify a fe
|
|||
|
||||
Edit `_config.yml`. Then:
|
||||
|
||||
- Replace `<site root>/index.md` with a modified [Minimal Mistakes `index.html`](https://github.com/mmistakes/minimal-mistakes/blob/master/index.html). Be sure to enable pagination if using the [`home` layout]({{ "/docs/layouts/#home-page" | absolute_url }}) by adding the necessary lines to **_config.yml**.
|
||||
- Replace `<site root>/index.md` with a modified [Minimal Mistakes `index.html`](https://github.com/mmistakes/minimal-mistakes/blob/master/index.html). Be sure to enable pagination if using the [`home` layout]({{ "/docs/layouts/#home-page" | relative_url }}) by adding the necessary lines to **_config.yml**.
|
||||
- Change `layout: post` in `_posts/0000-00-00-welcome-to-jekyll.markdown` to `layout: single`.
|
||||
- Remove `about.md`, or at the very least change `layout: page` to `layout: single` and remove references to `icon-github.html` (or [copy to your `_includes`](https://github.com/jekyll/minima/tree/master/_includes) if using it).
|
||||
|
||||
|
|
@ -174,7 +174,7 @@ gem "minimal-mistakes-jekyll"
|
|||
|
||||
Then run `bundle update` and add `theme: minimal-mistakes-jekyll` to your `_config.yml`.
|
||||
|
||||
**v4 Breaking Change:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | absolute_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | absolute_url }}) have changed and now require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: /assets/images/filename.jpg`. The preferred location is now `/assets/images/` but can be placed elsewhere or externally hosted. This applies to image references in `_config.yml` and `author.yml` as well.
|
||||
**v4 Breaking Change:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | relative_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | relative_url }}) have changed and now require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: /assets/images/filename.jpg`. The preferred location is now `/assets/images/` but can be placed elsewhere or externally hosted. This applies to image references in `_config.yml` and `author.yml` as well.
|
||||
{: .notice--danger}
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,17 +2,17 @@
|
|||
title: "Installation"
|
||||
permalink: /docs/installation/
|
||||
excerpt: "Instructions for installing the theme for new and existing Jekyll based sites."
|
||||
last_modified_at: 2018-01-03T11:30:48-05:00
|
||||
last_modified_at: 2018-03-20T15:59:00-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Install the Theme
|
||||
|
||||
**1.** For a **new site**, install the `minimal-mistakes-jekyll` theme gem or fork the Minimal Mistakes repo on GitHub following the steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | absolute_url }}).
|
||||
**1.** For a **new site**, install the `minimal-mistakes-jekyll` theme gem or fork the Minimal Mistakes repo on GitHub following the steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | relative_url }}).
|
||||
|
||||
If you plan to host with GitHub Pages be sure to properly setup [**jekyll-remote-theme**](https://github.com/benbalter/jekyll-remote-theme) as it is required for the theme to work properly.
|
||||
|
||||
**2.** For an **existing site** follow the steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | absolute_url }}). Then work through the guidelines below for migration and setup.
|
||||
**2.** For an **existing site** follow the steps outlined in the [*Quick-Start Guide*]({{ "/docs/quick-start-guide/" | relative_url }}). Then work through the guidelines below for migration and setup.
|
||||
|
||||
**3.** And for those who'd like to make substantial edits to the theme, it can be downloaded as a ZIP file to customize.
|
||||
|
||||
|
|
@ -99,7 +99,7 @@ $ bundle install
|
|||
{: .notice--warning}
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-bundle-install.gif' | absolute_url }}" alt="bundle install in Terminal window">
|
||||
<img src="{{ '/assets/images/mm-bundle-install.gif' | relative_url }}" alt="bundle install in Terminal window">
|
||||
</figure>
|
||||
|
||||
Depending on what gems you already have installed you may have to run `bundle update` to clear up any dependency issues. Bundler is usually pretty good at letting you know what gems need updating or have issues installing, to further investigate.
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
title: "Upgrading"
|
||||
permalink: /docs/upgrading/
|
||||
excerpt: "Instructions and suggestions for upgrading the theme."
|
||||
last_modified_at: 2018-01-08T20:10:30-05:00
|
||||
last_modified_at: 2018-03-20T15:59:07-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
If you're using the [Ruby Gem]({{ "/docs/quick-start-guide/#ruby-gem-method" | absolute_url }}) or [remote theme]({{ "/docs/quick-start-guide/#github-pages-method" | absolute_url }}) versions of Minimal Mistakes, upgrading is fairly painless.
|
||||
If you're using the [Ruby Gem]({{ "/docs/quick-start-guide/#ruby-gem-method" | relative_url }}) or [remote theme]({{ "/docs/quick-start-guide/#github-pages-method" | relative_url }}) versions of Minimal Mistakes, upgrading is fairly painless.
|
||||
|
||||
To check which version you are currently using, view the source of your built site and you should see something similar to:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Configuration"
|
||||
permalink: /docs/configuration/
|
||||
excerpt: "Settings for configuring and customizing the theme."
|
||||
last_modified_at: 2018-02-19T08:09:39-05:00
|
||||
last_modified_at: 2018-03-20T15:59:26-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
|
@ -130,7 +130,7 @@ minimal_mistakes_skin: "default" # "air", "aqua", "contrast", "dark", "dirt", "n
|
|||
|
||||
_Example:_ `locale: "en-US"` sets the `lang` attribute for the site to the _United States_ flavor of English, while `en-GB` would be for the `United Kingdom` style of English. Country codes are optional and the shorter variation `locale: "en"` is also acceptable. To find your language and country codes check this [reference table](<https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx>).
|
||||
|
||||
Properly setting the locale is important for associating localized text found in the [**UI Text**]({{ "/docs/ui-text/" | absolute_url }}) data file. An improper match will cause parts of the UI to disappear (eg. button labels, section headings, etc).
|
||||
Properly setting the locale is important for associating localized text found in the [**UI Text**]({{ "/docs/ui-text/" | relative_url }}) data file. An improper match will cause parts of the UI to disappear (eg. button labels, section headings, etc).
|
||||
|
||||
**Note:** The theme comes with localized text in English (`en`, `en-US`, `en-GB`). If you change `locale` in `_config.yml` to something else, most of the UI text will go blank. Be sure to add the corresponding locale key and translated text to `_data/ui-text.yml` to avoid this.
|
||||
{: .notice--warning}
|
||||
|
|
@ -233,7 +233,7 @@ header:
|
|||
```
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-teaser-images-example.jpg' | absolute_url }}" alt="teaser image example">
|
||||
<img src="{{ '/assets/images/mm-teaser-images-example.jpg' | relative_url }}" alt="teaser image example">
|
||||
<figcaption>Example of teaser images found in the related posts module.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -244,19 +244,19 @@ Enable breadcrumb links to help visitors better navigate deep sites. Because of
|
|||
1. Use a category based permalink structure e.g. `permalink: /:categories/:title/`
|
||||
2. Manually create pages for each category or use a plugin like [jekyll-archives][jekyll-archives] to auto-generate them. If these pages don't exist breadcrumb links to them will be broken.
|
||||
|
||||
![breadcrumb navigation example]({{ "/assets/images/mm-breadcrumbs-example.jpg" | absolute_url }})
|
||||
![breadcrumb navigation example]({{ "/assets/images/mm-breadcrumbs-example.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
breadcrumbs: true # disabled by default
|
||||
```
|
||||
|
||||
Breadcrumb start link text and separator character can both be changed in the [UI Text data file]({{ "/docs/ui-text/" | absolute_url }}).
|
||||
Breadcrumb start link text and separator character can both be changed in the [UI Text data file]({{ "/docs/ui-text/" | relative_url }}).
|
||||
|
||||
### Reading Time
|
||||
|
||||
Enable estimated reading time snippets with `read_time: true` in YAML Front Matter. `200` has been set as the default words per minute value --- which can be changed by adjusting `words_per_minute:` in `_config.yml`.
|
||||
|
||||
![reading time example]({{ "/assets/images/mm-read-time-example.jpg" | absolute_url }})
|
||||
![reading time example]({{ "/assets/images/mm-read-time-example.jpg" | relative_url }})
|
||||
|
||||
Instead of adding `read_time: true` to each post, apply as a default in `_config.yml` like so:
|
||||
|
||||
|
|
@ -434,7 +434,7 @@ To skip this moderation step simply set `moderation: false`.
|
|||
**ProTip:** Create a GitHub webhook that sends a `POST` request to the following payload URL `https://api.staticman.net/v2/webhook` and triggers a "Pull request" event to delete Staticman branches on merge.
|
||||
{: .notice--info}
|
||||
|
||||
![pull-request webhook]({{ "/assets/images/mm-staticman-pr-webhook.jpg" | absolute_url }})
|
||||
![pull-request webhook]({{ "/assets/images/mm-staticman-pr-webhook.jpg" | relative_url }})
|
||||
|
||||
###### reCAPTCHA Support (v2 only)
|
||||
|
||||
|
|
@ -470,7 +470,7 @@ atom_feed:
|
|||
|
||||
To enable site-wide search add `search: true` to your `_config.yml`.
|
||||
|
||||
![masthead search example]({{ "/assets/images/masthead-search.gif" | absolute_url }})
|
||||
![masthead search example]({{ "/assets/images/masthead-search.gif" | relative_url }})
|
||||
|
||||
#### Lunr (default)
|
||||
|
||||
|
|
@ -639,19 +639,19 @@ og_image: /assets/images/site-logo.png
|
|||
```
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-twitter-card-summary-image.jpg' | absolute_url }}" alt="Twitter Card summary example">
|
||||
<img src="{{ '/assets/images/mm-twitter-card-summary-image.jpg' | relative_url }}" alt="Twitter Card summary example">
|
||||
<figcaption>Example of a image placed in a Summary Card.</figcaption>
|
||||
</figure>
|
||||
|
||||
Documents who have a `header.image` assigned in their YAML Front Matter will appear like this when shared on Twitter and Facebook.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-twitter-card-summary-large.jpg' | absolute_url }}" alt="page shared on Twitter">
|
||||
<img src="{{ '/assets/images/mm-twitter-card-summary-large.jpg' | relative_url }}" alt="page shared on Twitter">
|
||||
<figcaption>Shared page on Twitter with header image assigned.</figcaption>
|
||||
</figure>
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/facebook-share-example.jpg' | absolute_url }}" alt="page shared on Facebook">
|
||||
<img src="{{ '/assets/images/facebook-share-example.jpg' | relative_url }}" alt="page shared on Facebook">
|
||||
<figcaption>Shared page on Facebook with header image assigned.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -701,7 +701,7 @@ To use another provider not included with the theme set `provider: "custom"` the
|
|||
|
||||
Used as the defaults for defining what appears in the author sidebar.
|
||||
|
||||
![author sidebar example]({{ "/assets/images/mm-author-sidebar-example.jpg" | absolute_url }})
|
||||
![author sidebar example]({{ "/assets/images/mm-author-sidebar-example.jpg" | relative_url }})
|
||||
|
||||
**Note:** For sites with multiple authors these values can be overridden post by post with custom YAML Front Matter and a data file. For more information on how that works see below.
|
||||
{: .notice--info}
|
||||
|
|
@ -718,7 +718,7 @@ author:
|
|||
|
||||
Social media links are all optional, include the ones you want visible. In most cases you just need to add the username. If you're unsure double check `_includes/author-profile.html` to see how the URL is constructed.
|
||||
|
||||
To add social media links not included with the theme or customize the author sidebar further, read the full [layout documentation]({{ "/docs/layouts/#author-profile" | absolute_url }}).
|
||||
To add social media links not included with the theme or customize the author sidebar further, read the full [layout documentation]({{ "/docs/layouts/#author-profile" | relative_url }}).
|
||||
|
||||
## Reading Files
|
||||
|
||||
|
|
@ -790,7 +790,7 @@ If [using pagination](https://github.com/jekyll/jekyll-paginate) on the homepage
|
|||
paginate: 5
|
||||
```
|
||||
|
||||
You'll also need to include some Liquid and HTML to properly use the paginator, which you can find in the **Layouts** section under [Home Page]({{ "/docs/layouts/#home-page" | absolute_url }}).
|
||||
You'll also need to include some Liquid and HTML to properly use the paginator, which you can find in the **Layouts** section under [Home Page]({{ "/docs/layouts/#home-page" | relative_url }}).
|
||||
|
||||
The paginator only works on files with name `index.html`. To use pagination in a subfolder --- for example `/recent/`, create `/recent/index.html` and set the `paginate_path` in `_config.yml` to this:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Overriding Theme Defaults"
|
||||
permalink: /docs/overriding-theme-defaults/
|
||||
excerpt: "Instructions on how to customize the theme's default set of layouts, includes, and stylesheets when using the Ruby Gem version."
|
||||
last_modified_at: 2016-11-03T10:49:48-04:00
|
||||
last_modified_at: 2018-03-20T15:59:31-04:00
|
||||
---
|
||||
|
||||
When installing the theme as a Ruby Gem its layouts, includes, stylesheets, and other assets are all bundled in the `gem`. Meaning they're not easily visible in your project.
|
||||
|
|
@ -24,4 +24,4 @@ Jekyll will use the files in your project first before falling back to the defau
|
|||
Additionally, from `v4.5.0` the theme-gem will also exhibit above behavior for `/_data` via a plugin.
|
||||
Consequently, the data files for UI Text and Navigation are also bundled within the theme-gem.
|
||||
|
||||
For more information on customizing the theme's [stylesheets]({{ "/docs/stylesheets/" | absolute_url }}) and [JavaScript]({{ "/docs/javascript/" | absolute_url }}), see the appropriate pages.
|
||||
For more information on customizing the theme's [stylesheets]({{ "/docs/stylesheets/" | relative_url }}) and [JavaScript]({{ "/docs/javascript/" | relative_url }}), see the appropriate pages.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Navigation"
|
||||
permalink: /docs/navigation/
|
||||
excerpt: "Instructions on how to customize the main navigation and enabling breadcrumb links."
|
||||
last_modified_at: 2016-11-03T10:50:03-04:00
|
||||
last_modified_at: 2018-03-20T15:59:40-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ main:
|
|||
|
||||
Which will give you a responsive masthead similar to this:
|
||||
|
||||
![priority plus masthead animation]({{ "/assets/images/mm-priority-plus-masthead.gif" | absolute_url }})
|
||||
![priority plus masthead animation]({{ "/assets/images/mm-priority-plus-masthead.gif" | relative_url }})
|
||||
|
||||
Optionally, you can add a `description` key per title in the `main` key. This `description` will show up like a tooltip, when the user hovers over the link on a desktop browser.
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ Enable breadcrumb links to help visitors better navigate deep sites. Because of
|
|||
1. Use a category based permalink structure e.g. `permalink: /:categories/:title/`
|
||||
2. Manually create pages for each category or use a plugin like [jekyll-archives](https://github.com/jekyll/jekyll-archives) to auto-generate them. If these pages don't exist breadcrumb links to them will be broken.
|
||||
|
||||
![breadcrumb navigation example]({{ "/assets/images/mm-breadcrumbs-example.jpg" | absolute_url }})
|
||||
![breadcrumb navigation example]({{ "/assets/images/mm-breadcrumbs-example.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
breadcrumbs: true # disabled by default
|
||||
|
|
@ -68,4 +68,4 @@ breadcrumb_separator : ">"
|
|||
|
||||
## Custom Sidebar Navigation Menu
|
||||
|
||||
See the [**sidebars** documentation]({{ "/docs/layouts/#custom-sidebar-navigation-menu" | absolute_url }}) for information on setting up a custom navigation menu.
|
||||
See the [**sidebars** documentation]({{ "/docs/layouts/#custom-sidebar-navigation-menu" | relative_url }}) for information on setting up a custom navigation menu.
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: "UI Text"
|
||||
permalink: /docs/ui-text/
|
||||
excerpt: "Text for customizing various user interface elements found in the theme."
|
||||
last_modified_at: 2017-12-28T13:51:58-05:00
|
||||
last_modified_at: 2018-03-20T15:59:46-04:00
|
||||
---
|
||||
|
||||
Text for various UI elements, `_layouts`, and `_includes` have all been grouped together as a set of translation keys. This is by no means a full-on i18n solution, but it does help make customizing things a bit easier.
|
||||
|
|
@ -34,7 +34,7 @@ If you're are interested in localizing them into other languages feel free to su
|
|||
|
||||
Many of the label based keys like `meta_label`, `categories_label`, `tags_label`, `share_on_label`, and `follow_label` can be left blank if you'd like to omit them from view. It really depends on you and if you want an even more minimal look to your site.
|
||||
|
||||
![UI text labels]({{ "/assets/images/mm-ui-text-labels.jpg" | absolute_url }})
|
||||
![UI text labels]({{ "/assets/images/mm-ui-text-labels.jpg" | relative_url }})
|
||||
|
||||
**Note:** The theme comes with localized text in English (`en`, `en-US`, `en-GB`). If you change `locale` in `_config.yml` to something else, most of the UI text will go blank. Be sure to add the corresponding locale key and translated text to `_data/ui-text.yml` to avoid this.
|
||||
{: .notice--warning}
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ single_layout_gallery:
|
|||
alt: "single layout with header example"
|
||||
- image_path: /assets/images/mm-layout-single-meta.png
|
||||
alt: "single layout with comments and related posts"
|
||||
last_modified_at: 2018-03-20T15:06:31-04:00
|
||||
last_modified_at: 2018-03-20T15:59:52-04:00
|
||||
toc: true
|
||||
toc_label: "Included Layouts"
|
||||
toc_icon: "columns"
|
||||
|
|
@ -89,7 +89,7 @@ The layout you'll likely use the most --- sidebar and main content combo.
|
|||
|
||||
{% include gallery id="single_layout_gallery" caption="Image header and meta info examples for `single` layout" %}
|
||||
|
||||
Assign with `layout: single` , or better yet apply as a [Front Matter default]({{ "/docs/configuration/#front-matter-defaults" | absolute_url }}) in `_config.yml`.
|
||||
Assign with `layout: single` , or better yet apply as a [Front Matter default]({{ "/docs/configuration/#front-matter-defaults" | relative_url }}) in `_config.yml`.
|
||||
|
||||
### Wide Page
|
||||
|
||||
|
|
@ -106,7 +106,7 @@ classes: wide
|
|||
|
||||
Auto-generated table of contents list for your posts and pages can be enabled by adding `toc: true` to the YAML Front Matter.
|
||||
|
||||
![table of contents example]({{ "/assets/images/mm-toc-helper-example.jpg" | absolute_url }})
|
||||
![table of contents example]({{ "/assets/images/mm-toc-helper-example.jpg" | relative_url }})
|
||||
|
||||
| Parameter | Required | Description | Default |
|
||||
| --------- | -------- | ----------- | ------- |
|
||||
|
|
@ -135,7 +135,7 @@ Essentially the same as `single` with markup adjustments and some modules remove
|
|||
* List and grid views
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-layout-archive.png' | absolute_url }}" alt="archive layout example">
|
||||
<img src="{{ '/assets/images/mm-layout-archive.png' | relative_url }}" alt="archive layout example">
|
||||
<figcaption>List view example.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -190,14 +190,14 @@ header:
|
|||
teaser: path-to-teaser-image.jpg
|
||||
```
|
||||
|
||||
**Note:** More information on using this `_include` can be found under [**Helpers**]({{ "/docs/helpers/" | absolute_url }}).
|
||||
**Note:** More information on using this `_include` can be found under [**Helpers**]({{ "/docs/helpers/" | relative_url }}).
|
||||
{: .notice--info}
|
||||
|
||||
## Taxonomy Archives
|
||||
|
||||
If you have the luxury of using Jekyll plugins, the creation of category and tag archives is greatly simplified. Simply enable support for the [`jekyll-archives`](https://github.com/jekyll/jekyll-archives) plugin with a few `_config.yml` settings as noted in the [**Configuration**]({{ "/docs/configuration/#archive-settings" | absolute_url }}) section and you're good to go.
|
||||
If you have the luxury of using Jekyll plugins, the creation of category and tag archives is greatly simplified. Simply enable support for the [`jekyll-archives`](https://github.com/jekyll/jekyll-archives) plugin with a few `_config.yml` settings as noted in the [**Configuration**]({{ "/docs/configuration/#archive-settings" | relative_url }}) section and you're good to go.
|
||||
|
||||
![archive taxonomy layout example]({{ "/assets/images/mm-layout-archive-taxonomy.png" | absolute_url }})
|
||||
![archive taxonomy layout example]({{ "/assets/images/mm-layout-archive-taxonomy.png" | relative_url }})
|
||||
|
||||
If you're not using the `jekyll-archives` plugin then you need to create archive pages yourself. Sample taxonomy archives can be found by grabbing the Markdown sources below and adding to your site.
|
||||
|
||||
|
|
@ -286,10 +286,10 @@ taxonomy: foo bar
|
|||
|
||||
## Home Page Layout
|
||||
|
||||
A derivative archive page layout to be used as a simple home page. It is built to show a paginated list of recent posts based off of the [pagination settings]({{ "/docs/configuration/#paginate" | absolute_url }}) in `_config.yml`.
|
||||
A derivative archive page layout to be used as a simple home page. It is built to show a paginated list of recent posts based off of the [pagination settings]({{ "/docs/configuration/#paginate" | relative_url }}) in `_config.yml`.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-home-post-pagination-example.jpg' | absolute_url }}" alt="paginated home page example">
|
||||
<img src="{{ '/assets/images/mm-home-post-pagination-example.jpg' | relative_url }}" alt="paginated home page example">
|
||||
<figcaption>Example of a paginated home page showing 5 recent posts.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -318,7 +318,7 @@ Then adjust the `paginate_path` in **_config.yml** to match.
|
|||
paginate_path: /blog/page:num
|
||||
```
|
||||
|
||||
**Note:** Jekyll can only paginate a single `index.html` file. If you'd like to paginate more pages (e.g. category indexes) you'll need the help of a custom plugin. For more pagination related settings check the [**Configuration**]({{ "/docs/configuration/#paginate" | absolute_url }}) section.
|
||||
**Note:** Jekyll can only paginate a single `index.html` file. If you'd like to paginate more pages (e.g. category indexes) you'll need the help of a custom plugin. For more pagination related settings check the [**Configuration**]({{ "/docs/configuration/#paginate" | relative_url }}) section.
|
||||
{: .notice--info}
|
||||
|
||||
## Splash Page Layout
|
||||
|
|
@ -331,17 +331,17 @@ For full-width landing pages that need a little something extra add `layout: spl
|
|||
* Optional header overlay (solid color/image) + text and optional "call to action" button
|
||||
* Feature blocks (`left`, `center`, and `right` alignment options)
|
||||
|
||||
![splash page layout example]({{ "/assets/images/mm-layout-splash.png" | absolute_url }})
|
||||
![splash page layout example]({{ "/assets/images/mm-layout-splash.png" | relative_url }})
|
||||
|
||||
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**]({{ "/docs/helpers/" | absolute_url }}) section or review a [sample splash page](https://github.com/{{ site.repository }}/blob/master/docs/_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**]({{ "/docs/helpers/" | relative_url }}) section or review a [sample splash page](https://github.com/{{ site.repository }}/blob/master/docs/_pages/splash-page.md).
|
||||
|
||||
## Search Page Layout
|
||||
|
||||
A page with a search form. Add `layout: search` to the YAML Front Matter similar to [this example](https://github.com/mmistakes/minimal-mistakes/blob/master/docs/_pages/search.md) on the demo site.
|
||||
|
||||
![search page layout example]({{ "/assets/images/search-layout-example.png" | absolute_url }})
|
||||
![search page layout example]({{ "/assets/images/search-layout-example.png" | relative_url }})
|
||||
|
||||
**Note:** A page using the `layout: search` isn't compatible with the new [site search feature]({{ "/docs/configuration/#site-search" | absolute_url }}) incorporated in the masthead.
|
||||
**Note:** A page using the `layout: search` isn't compatible with the new [site search feature]({{ "/docs/configuration/#site-search" | relative_url }}) incorporated in the masthead.
|
||||
{: .notice--warning}
|
||||
|
||||
### Exclusions
|
||||
|
|
@ -363,10 +363,10 @@ To add some visual punch to a post or page, a large full-width header image can
|
|||
|
||||
Be sure to resize your header images. `~1280px` is a good width if you aren't [responsively serving up images](http://alistapart.com/article/responsive-images-in-practice). Through the magic of CSS they will scale up or down to fill the container. If you go with something too small it will look like garbage when upscaled, and something too large will hurt performance.
|
||||
|
||||
**Please Note:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | absolute_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | absolute_url }}) have changed and require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: /assets/images/filename.jpg`. The preferred location is now `/assets/images/`, but can be placed elsewhere or external hosted. This all applies for image references in `_config.yml` and `author.yml` as well.
|
||||
**Please Note:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | relative_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | relative_url }}) have changed and require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: /assets/images/filename.jpg`. The preferred location is now `/assets/images/`, but can be placed elsewhere or external hosted. This all applies for image references in `_config.yml` and `author.yml` as well.
|
||||
{: .notice--danger}
|
||||
|
||||
![single layout header image example]({{ "/assets/images/mm-single-header-example.jpg" | absolute_url }})
|
||||
![single layout header image example]({{ "/assets/images/mm-single-header-example.jpg" | relative_url }})
|
||||
|
||||
Place your images in the `/assets/images/` folder and add the following YAML Front Matter:
|
||||
|
||||
|
|
@ -427,11 +427,11 @@ header:
|
|||
|
||||
You'd get a header image overlaid with text and a call to action button like this:
|
||||
|
||||
![single layout header overlay example]({{ "/assets/images/mm-single-header-overlay-example.jpg" | absolute_url }})
|
||||
![single layout header overlay example]({{ "/assets/images/mm-single-header-overlay-example.jpg" | relative_url }})
|
||||
|
||||
You also have the option of specifying a solid background-color to use instead of an image.
|
||||
|
||||
![single layout header overlay with background fill]({{ "/assets/images/mm-single-header-overlay-fill-example.jpg" | absolute_url }})
|
||||
![single layout header overlay with background fill]({{ "/assets/images/mm-single-header-overlay-fill-example.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should display a **header with a solid background color**, if the theme supports it."
|
||||
|
|
@ -441,7 +441,7 @@ header:
|
|||
|
||||
You can also specifying the opacity (between `0` and `1`) of a black overlay like so:
|
||||
|
||||
![transparent black overlay]({{ "/assets/images/mm-header-overlay-black-filter.jpg" | absolute_url }})
|
||||
![transparent black overlay]({{ "/assets/images/mm-header-overlay-black-filter.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should [...]"
|
||||
|
|
@ -455,7 +455,7 @@ header:
|
|||
|
||||
Or if you want to do more fancy things, go full rgba:
|
||||
|
||||
![transparent red overlay]({{ "/assets/images/mm-header-overlay-red-filter.jpg" | absolute_url }})
|
||||
![transparent red overlay]({{ "/assets/images/mm-header-overlay-red-filter.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should [...]"
|
||||
|
|
@ -490,7 +490,7 @@ The space to the left of a page's main content is blank by default, but has the
|
|||
|
||||
Add `author_profile: true` to a post or page's YAML Front Matter.
|
||||
|
||||
![single layout example]({{ "/assets/images/mm-layout-single.png" | absolute_url }})
|
||||
![single layout example]({{ "/assets/images/mm-layout-single.png" | relative_url }})
|
||||
|
||||
Better yet, enable it with Front Matter Defaults set in `_config.yml`.
|
||||
|
||||
|
|
@ -507,7 +507,7 @@ defaults:
|
|||
**Note:** To disable the author sidebar profile for a specific post or page, add `author_profile: false` to the YAML Front Matter instead.
|
||||
{: .notice--warning}
|
||||
|
||||
The theme comes pre-built with a selection of links for the most common social media networks. These are all optional and can be [assigned in `_config.yml`]({{ "/docs/configuration/" | absolute_url }}).
|
||||
The theme comes pre-built with a selection of links for the most common social media networks. These are all optional and can be [assigned in `_config.yml`]({{ "/docs/configuration/" | relative_url }}).
|
||||
|
||||
To add more links you'll need to crack open [`_includes/author-profile-custom-links.html`](https://github.com/mmistakes/minimal-mistakes/blob/master/_includes/author-profile-custom-links.html) and add the appropriate `<li>` markup shown below.
|
||||
|
||||
|
|
@ -558,7 +558,7 @@ To end up with:
|
|||
</li>
|
||||
```
|
||||
|
||||
![Reddit link in author profile]({{ "/assets/images/mm-author-profile-reddit-gs.png" | absolute_url }})
|
||||
![Reddit link in author profile]({{ "/assets/images/mm-author-profile-reddit-gs.png" | relative_url }})
|
||||
|
||||
To add a touch of color to the default black (`#000`) icon a few more steps are necessary.
|
||||
|
||||
|
|
@ -575,12 +575,12 @@ Simply add a `color` declaration and the corresponding hex code.
|
|||
}
|
||||
```
|
||||
|
||||
![Reddit link in author profile with color]({{ "/assets/images/mm-author-profile-reddit-color.png" | absolute_url }})
|
||||
![Reddit link in author profile with color]({{ "/assets/images/mm-author-profile-reddit-color.png" | relative_url }})
|
||||
|
||||
**ProTip:** For bonus points you can add it as a Sass `$variable` that you set in [`_variables.scss`](https://github.com/mmistakes/minimal-mistakes/blob/master/_sass/minimal-mistakes/_variables.scss) like the other ["brand" colors](http://brandcolors.net/). You'll need to add this file to `/_sass/` as well if you're using the Ruby Gem version of the theme.
|
||||
{: .notice--info}
|
||||
|
||||
**Please please please** don't submit [pull requests]({{ "/docs/contributing/" | absolute_url }}) adding in support for "missing" social media links. I'm trying to keep things down to the minimum (hence the theme's name) and have no interest in merging such PRs :expressionless:.
|
||||
**Please please please** don't submit [pull requests]({{ "/docs/contributing/" | relative_url }}) adding in support for "missing" social media links. I'm trying to keep things down to the minimum (hence the theme's name) and have no interest in merging such PRs :expressionless:.
|
||||
{: .notice--warning}
|
||||
|
||||
### Custom Sidebar Content
|
||||
|
|
@ -607,7 +607,7 @@ sidebar:
|
|||
```
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-custom-sidebar-example.jpg' | absolute_url }}" alt="custom sidebar content example">
|
||||
<img src="{{ '/assets/images/mm-custom-sidebar-example.jpg' | relative_url }}" alt="custom sidebar content example">
|
||||
<figcaption>Example of custom sidebar content added as YAML Front Matter.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -621,7 +621,7 @@ To create a sidebar menu[^sidebar-menu] similar to the one found in the theme's
|
|||
[^sidebar-menu]: Sidebar menu supports 1 level of nested links.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-custom-sidebar-nav.jpg' | absolute_url }}" alt="sidebar navigation example">
|
||||
<img src="{{ '/assets/images/mm-custom-sidebar-nav.jpg' | relative_url }}" alt="sidebar navigation example">
|
||||
<figcaption>Custom sidebar navigation menu example.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -707,7 +707,7 @@ defaults:
|
|||
|
||||
The `single` layout has an option to enable social links at the bottom of posts for sharing on Twitter, Facebook, Google+, and LinkedIn. Similar to the links found in the author sidebar, the theme ships with defaults for the most common social networks.
|
||||
|
||||
![default social share link buttons]({{ "/assets/images/mm-social-share-links-default.png" | absolute_url }})
|
||||
![default social share link buttons]({{ "/assets/images/mm-social-share-links-default.png" | relative_url }})
|
||||
|
||||
To enable these links add `share: true` to a post or page's YAML Front Matter or use a [default](https://jekyllrb.com/docs/configuration/#front-matter-defaults) in your `_config.yml` to apply more globally.
|
||||
|
||||
|
|
@ -716,7 +716,7 @@ If you'd like to add, remove, or change the order of these default links you can
|
|||
Let's say you wanted to replace the Google+ button with a Reddit one. Simply replace the HTML with the following:
|
||||
|
||||
```html
|
||||
{% raw %}<a href="https://www.reddit.com/submit?url={{ page.url | absolute_url }}&title={{ page.title }}" class="btn" title="{{ site.data.ui-text[site.locale].share_on_label }} Reddit"><i class="fab fa-fw fa-reddit" aria-hidden="true"></i><span> Reddit</span></a>{% endraw %}
|
||||
{% raw %}<a href="https://www.reddit.com/submit?url={{ page.url | relative_url }}&title={{ page.title }}" class="btn" title="{{ site.data.ui-text[site.locale].share_on_label }} Reddit"><i class="fab fa-fw fa-reddit" aria-hidden="true"></i><span> Reddit</span></a>{% endraw %}
|
||||
```
|
||||
|
||||
The important parts to change are:
|
||||
|
|
@ -726,9 +726,9 @@ The important parts to change are:
|
|||
3. [Font Awesome icon](http://fontawesome.io/icons/) (`fa-` class)
|
||||
4. Link label
|
||||
|
||||
![Reddit social share link button]({{ "/assets/images/mm-social-share-links-reddit-gs.png" | absolute_url }})
|
||||
![Reddit social share link button]({{ "/assets/images/mm-social-share-links-reddit-gs.png" | relative_url }})
|
||||
|
||||
To change the color of the button use one of the built in [utility classes]({{ "/docs/utility-classes/#buttons" | absolute_url }}). Or you can create a new button class to match whatever color you want.
|
||||
To change the color of the button use one of the built in [utility classes]({{ "/docs/utility-classes/#buttons" | relative_url }}). Or you can create a new button class to match whatever color you want.
|
||||
|
||||
Under the `$social` color map in `assets/_scss/_buttons.scss` simply add a name (this will be appened to `btn--`) that matches the new button class. In our case `reddit` ~> `.btn--reddit`.
|
||||
|
||||
|
|
@ -744,10 +744,10 @@ $social:
|
|||
**ProTip:** For bonus points you can add it as a Sass `$variable` that you set in `_variables.scss` like the other ["brand" colors](http://brandcolors.net/).
|
||||
{: .notice--info}
|
||||
|
||||
Add the new `.btn--reddit` class to the `<a>` element from earlier, [compile `main.css`]({{ "/docs/stylesheets/" | absolute_url }}) and away you go.
|
||||
Add the new `.btn--reddit` class to the `<a>` element from earlier, [compile `main.css`]({{ "/docs/stylesheets/" | relative_url }}) and away you go.
|
||||
|
||||
```html
|
||||
{% raw %}<a href="https://www.reddit.com/submit?url={{ page.url | absolute_url }}&title={{ page.title }}" class="btn btn--reddit" title="{{ site.data.ui-text[site.locale].share_on_label }} Reddit"><i class="fab fa-fw fa-reddit" aria-hidden="true"></i><span> Reddit</span></a>{% endraw %}
|
||||
{% raw %}<a href="https://www.reddit.com/submit?url={{ page.url | relative_url }}&title={{ page.title }}" class="btn btn--reddit" title="{{ site.data.ui-text[site.locale].share_on_label }} Reddit"><i class="fab fa-fw fa-reddit" aria-hidden="true"></i><span> Reddit</span></a>{% endraw %}
|
||||
```
|
||||
|
||||
![Reddit social share link button]({{ "/assets/images/mm-social-share-links-reddit-color.png" | absolute_url }})
|
||||
![Reddit social share link button]({{ "/assets/images/mm-social-share-links-reddit-color.png" | relative_url }})
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Working with Posts"
|
||||
permalink: /docs/posts/
|
||||
excerpt: "Suggestions and Front Matter defaults for working with posts."
|
||||
last_modified_at: 2016-11-03T11:12:40-04:00
|
||||
last_modified_at: 2018-03-20T15:59:57-04:00
|
||||
---
|
||||
|
||||
Posts are stored in the `_posts` directory and named according to the `YEAR-MONTH-DAY-title.MARKUP` format as per [the usual](https://jekyllrb.com/docs/posts/).
|
||||
|
|
@ -31,7 +31,7 @@ defaults:
|
|||
related: true
|
||||
```
|
||||
|
||||
Adding the above to `_config.yml` will assign the `single` layout and enable: *author profile*, *reading time*, *comments*, [*social sharing links*]({{ "/docs/layouts/#social-sharing-links" | absolute_url }}), and *related posts*, for all posts.
|
||||
Adding the above to `_config.yml` will assign the `single` layout and enable: *author profile*, *reading time*, *comments*, [*social sharing links*]({{ "/docs/layouts/#social-sharing-links" | relative_url }}), and *related posts*, for all posts.
|
||||
|
||||
**ProTip:** Remember to write unique `excerpt` descriptions for each post for improved SEO and archive listings.
|
||||
{: .notice--info}
|
||||
|
|
@ -2,12 +2,12 @@
|
|||
title: "Working with Collections"
|
||||
permalink: /docs/collections/
|
||||
excerpt: "Suggestions and Front Matter defaults for working with collections."
|
||||
last_modified_at: 2016-11-03T11:13:38-04:00
|
||||
last_modified_at: 2018-03-20T16:00:02-04:00
|
||||
---
|
||||
|
||||
Collections like posts and pages work as you'd expect. If you're new to them be sure to read [Jekyll's documentation](https://jekyllrb.com/docs/collections/).
|
||||
|
||||
The theme has been built with collections in mind and you will find [several examples]({{ "/collection-archive/" | absolute_url }}) on the demo site ([portfolio]({{ "/portfolio/" | absolute_url }}), [recipes]({{ "/recipes/" | absolute_url }}), pets).
|
||||
The theme has been built with collections in mind and you will find [several examples]({{ "/collection-archive/" | relative_url }}) on the demo site ([portfolio]({{ "/portfolio/" | relative_url }}), [recipes]({{ "/recipes/" | relative_url }}), pets).
|
||||
|
||||
**Collections in the Wild:** This set of documentation is also [built as a collection](https://github.com/{{ site.repository }}/blob/master/docs/_docs/) if you're looking for a fully fleshed out example to inspect.
|
||||
{: .notice--info}
|
||||
|
|
@ -43,4 +43,4 @@ defaults:
|
|||
|
||||
And then create portfolio content like [`_portfolio/foo-bar-website.md`](https://github.com/{{ site.repository }}/blob/master/docs/_portfolio/foo-bar-website.md), to end up with something like this.
|
||||
|
||||
![portfolio collection example]({{ "/assets/images/mm-portfolio-collection-example.jpg" | absolute_url }})
|
||||
![portfolio collection example]({{ "/assets/images/mm-portfolio-collection-example.jpg" | relative_url }})
|
||||
|
|
@ -30,7 +30,7 @@ feature_row:
|
|||
- image_path: /assets/images/unsplash-gallery-image-3-th.jpg
|
||||
title: "Placeholder 3"
|
||||
excerpt: "This is some sample content that goes here with **Markdown** formatting."
|
||||
last_modified_at: 2018-01-09T14:26:13-05:00
|
||||
last_modified_at: 2018-03-20T16:00:09-04:00
|
||||
toc: true
|
||||
toc_label: "Helpers"
|
||||
toc_icon: "cogs"
|
||||
|
|
@ -40,11 +40,11 @@ You can think of these Jekyll helpers as little shortcuts. Since GitHub Pages do
|
|||
|
||||
## Base Path
|
||||
|
||||
**Deprecated**. Use `absolute_url` filter instead.
|
||||
**Deprecated**. Use `relative_url` filter instead.
|
||||
|
||||
Instead of repeating `{% raw %}{{ site.url }}{{ site.baseurl }}{% endraw %}` over and over again to create absolute URLs, you can use `{% raw %}{{ base_path }}{% endraw %}` instead. Simply add `{% raw %}{% include base_path %}{% endraw %}` to layouts, posts, pages, collections, or other includes and you're good to go.
|
||||
|
||||
**ProTip:** It's a good practice to use absolute URL paths for assets (especially post images) so they correctly resolve in the site's XML feeds. Example: `{% raw %}{{ "/assets/images/filename.jpg" | absolute_url }}{% endraw %}` ~> `https://yourdoamin.com/assets/images/filename.jpg`
|
||||
**ProTip:** It's a good practice to use absolute URL paths for assets (especially post images) so they correctly resolve in the site's XML feeds. Example: `{% raw %}{{ "/assets/images/filename.jpg" | relative_url }}{% endraw %}` ~> `https://yourdoamin.com/assets/images/filename.jpg`
|
||||
{: .notice--info}
|
||||
|
||||
## Group by Array
|
||||
|
|
@ -125,12 +125,12 @@ 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](https://github.com/{{ site.repository }}/blob/master/docs/_posts/2010-09-09-post-gallery.md) can be seen in [this sample gallery post]({{ "" | absolute_url }}{% post_url 2010-09-09-post-gallery %}).
|
||||
**More Gallery Goodness:** A few more examples and [source code](https://github.com/{{ site.repository }}/blob/master/docs/_posts/2010-09-09-post-gallery.md) can be seen in [this sample gallery post]({{ "" | relative_url }}{% post_url 2010-09-09-post-gallery %}).
|
||||
{: .notice--info}
|
||||
|
||||
## Feature Row
|
||||
|
||||
Designed to compliment the [`splash`]({{ "/docs/layouts/#splash-page-layout" | absolute_url }}) page layout as a way of arranging and aligning "feature blocks" containing text or image.
|
||||
Designed to compliment the [`splash`]({{ "/docs/layouts/#splash-page-layout" | relative_url }}) page layout as a way of arranging and aligning "feature blocks" containing text or image.
|
||||
|
||||
To add a feature row containing three content blocks with text and image, add the following YAML Front Matter
|
||||
|
||||
|
|
@ -142,7 +142,7 @@ To add a feature row containing three content blocks with text and image, add th
|
|||
| **excerpt** | Optional | Content block excerpt text. Markdown is allowed. | |
|
||||
| **url** | Optional | URL that the button should link to. | |
|
||||
| **btn_label** | Optional | Button text label. | `more_label` in UI Text data file. |
|
||||
| **btn_class** | Optional | Button style. See [utility classes]({{ "/docs/utility-classes/#buttons" | absolute_url }}) for options. | `btn` |
|
||||
| **btn_class** | Optional | Button style. See [utility classes]({{ "/docs/utility-classes/#buttons" | relative_url }}) for options. | `btn` |
|
||||
|
||||
```yaml
|
||||
feature_row:
|
||||
|
|
@ -175,7 +175,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]({{ "/splash-page/" | absolute_url }}) and [source code](https://github.com/{{ site.repository }}/blob/master/docs/_pages/splash-page.md) can be seen in the demo site.
|
||||
**More Feature Row Goodness:** A [few more examples]({{ "/splash-page/" | relative_url }}) and [source code](https://github.com/{{ site.repository }}/blob/master/docs/_pages/splash-page.md) can be seen in the demo site.
|
||||
{: .notice--info}
|
||||
|
||||
## Responsive Video Embed
|
||||
|
|
@ -229,7 +229,7 @@ header:
|
|||
|
||||
Auto-generated table of contents list for your posts and pages can be enabled using two methods.
|
||||
|
||||
![table of contents example]({{ "/assets/images/mm-toc-helper-example.jpg" | absolute_url }})
|
||||
![table of contents example]({{ "/assets/images/mm-toc-helper-example.jpg" | relative_url }})
|
||||
|
||||
### Enabled via YAML Front Matter
|
||||
|
||||
|
|
@ -283,7 +283,7 @@ To include a Kramdown [auto-generated table of contents](https://kramdown.gettal
|
|||
|
||||
Include an unordered list of links to be used as sidebar navigation with the `nav_list` helper.
|
||||
|
||||
**1.** Start by adding a set of titles and URLs to `_data/navigation.yml` in the same way the [`main` navigation]({{ "/docs/navigation/" | absolute_url }}) is built.
|
||||
**1.** Start by adding a set of titles and URLs to `_data/navigation.yml` in the same way the [`main` navigation]({{ "/docs/navigation/" | relative_url }}) is built.
|
||||
|
||||
`foo` navigation example:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Utility Classes"
|
||||
permalink: /docs/utility-classes/
|
||||
excerpt: "CSS classes for aligning text/image, styling buttons and notices, and more."
|
||||
last_modified_at: 2017-10-20T12:36:34-04:00
|
||||
last_modified_at: 2018-03-20T16:00:15-04:00
|
||||
toc: true
|
||||
toc_label: "Utility Classes"
|
||||
toc_icon: "gears"
|
||||
|
|
@ -69,7 +69,7 @@ No wrap text.
|
|||
|
||||
Position images with the following classes.
|
||||
|
||||
![image-center]({{ "/assets/images/image-alignment-580x300.jpg" | absolute_url }}){: .align-center}
|
||||
![image-center]({{ "/assets/images/image-alignment-580x300.jpg" | relative_url }}){: .align-center}
|
||||
|
||||
The image above happens to be **centered**.
|
||||
|
||||
|
|
@ -79,7 +79,7 @@ The image above happens to be **centered**.
|
|||
|
||||
---
|
||||
|
||||
![image-left]({{ "/assets/images/image-alignment-150x150.jpg" | absolute_url }}){: .align-left} The rest of this paragraph is filler for the sake of seeing the text wrap around the 150×150 image, which is **left aligned**. There should be plenty of room above, below, and to the right of the image. Just look at him there --- Hey guy! Way to rock that left side. I don't care what the right aligned image says, you look great. Don't let anyone else tell you differently.
|
||||
![image-left]({{ "/assets/images/image-alignment-150x150.jpg" | relative_url }}){: .align-left} The rest of this paragraph is filler for the sake of seeing the text wrap around the 150×150 image, which is **left aligned**. There should be plenty of room above, below, and to the right of the image. Just look at him there --- Hey guy! Way to rock that left side. I don't care what the right aligned image says, you look great. Don't let anyone else tell you differently.
|
||||
|
||||
```markdown
|
||||
{: .align-left}
|
||||
|
|
@ -87,7 +87,7 @@ The image above happens to be **centered**.
|
|||
|
||||
---
|
||||
|
||||
![image-right]({{ "/assets/images/image-alignment-300x200.jpg" | absolute_url }}){: .align-right}
|
||||
![image-right]({{ "/assets/images/image-alignment-300x200.jpg" | relative_url }}){: .align-right}
|
||||
|
||||
And now we're going to shift things to the **right align**. Again, there should be plenty of room above, below, and to the left of the image. Just look at him there --- Hey guy! Way to rock that right side. I don't care what the left aligned image says, you look great. Don't let anyone else tell you differently.
|
||||
|
||||
|
|
@ -97,7 +97,7 @@ And now we're going to shift things to the **right align**. Again, there should
|
|||
|
||||
---
|
||||
|
||||
![full]({{ "/assets/images/image-alignment-1200x4002.jpg" | absolute_url }})
|
||||
![full]({{ "/assets/images/image-alignment-1200x4002.jpg" | relative_url }})
|
||||
{: .full}
|
||||
|
||||
The image above should extend outside of the parent container on right.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Stylesheets"
|
||||
permalink: /docs/stylesheets/
|
||||
excerpt: "Instructions for customizing and building the theme's stylesheets."
|
||||
last_modified_at: 2018-01-09T09:59:16-05:00
|
||||
last_modified_at: 2018-03-20T16:00:22-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
|
@ -76,7 +76,7 @@ Before any `@import` lines.
|
|||
To mimic the look of type set in a printed book or manuscript you may want to enable paragraph indention. When `$paragraph-indent` is set to `true` indents are added to each sibling and the margin below each paragraph is removed.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-paragraph-indent-example.jpg' | absolute_url }}" alt="indented paragraph example">
|
||||
<img src="{{ '/assets/images/mm-paragraph-indent-example.jpg' | relative_url }}" alt="indented paragraph example">
|
||||
<figcaption>Example of indented paragraphs.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -157,7 +157,7 @@ Code block colors can easily be changed by overriding any of the following color
|
|||
|
||||
##### Default
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* default syntax highlighting (base16) */
|
||||
|
|
@ -181,7 +181,7 @@ $base0f: #ff5370;
|
|||
|
||||
##### Solarized Light
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* solarized light syntax highlighting (base16) */
|
||||
|
|
@ -205,7 +205,7 @@ $base0f: #d33682 !default;
|
|||
|
||||
##### Contrast
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* contrast syntax highlighting (base16) */
|
||||
|
|
@ -229,7 +229,7 @@ $base0f: #b18a3d;
|
|||
|
||||
##### Dark
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* dark syntax highlighting (base16) */
|
||||
|
|
@ -253,7 +253,7 @@ $base0f: #cc6633;
|
|||
|
||||
##### Dirt
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* dirt syntax highlighting (base16) */
|
||||
|
|
@ -277,7 +277,7 @@ $base0f: #b49368;
|
|||
|
||||
##### Neon
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* neon syntax highlighting (base16) */
|
||||
|
|
@ -301,7 +301,7 @@ $base0f: #cc6633;
|
|||
|
||||
##### Plum
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* plum syntax highlighting (base16) */
|
||||
|
|
@ -325,7 +325,7 @@ $base0f: #cc6633;
|
|||
|
||||
##### Sunrise
|
||||
|
||||
|
||||
|
||||
|
||||
```scss
|
||||
/* sunrise syntax highlighting (base16) */
|
||||
|
|
@ -354,7 +354,7 @@ Probably won't need to touch these, but they're there if you need to. Width vari
|
|||
And `$susy` is used for setting [the grid](http://susy.oddbird.net/) the theme uses. Uncommenting the lines under `debug` can be useful if you want to show the columns when adjusting the layout.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/mm-susy-grid-overlay.jpg' | absolute_url }}" alt="Susy grid overlay for debugging">
|
||||
<img src="{{ '/assets/images/mm-susy-grid-overlay.jpg' | relative_url }}" alt="Susy grid overlay for debugging">
|
||||
<figcaption>Susy grid debug overlay enabled.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ permalink: /docs/history/
|
|||
excerpt: "Change log of enhancements and bug fixes made to the theme."
|
||||
sidebar:
|
||||
nav: docs
|
||||
last_modified_at: 2018-03-20T15:28:11-04:00
|
||||
last_modified_at: 2018-03-20T16:00:27-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
|
@ -17,7 +17,7 @@ toc: true
|
|||
|
||||
### Bug Fixes
|
||||
|
||||
* Replace `absolute_url` filter with `relative_url` where it makes sense (asset/nagivation related paths). [#1588](https://github.com/mmistakes/minimal-mistakes/issues/1588)
|
||||
* Replace `relative_url` filter with `relative_url` where it makes sense (asset/nagivation related paths). [#1588](https://github.com/mmistakes/minimal-mistakes/issues/1588)
|
||||
* Fix search excerpts that run together because of implied spaces.
|
||||
|
||||
## [4.10.1](https://github.com/mmistakes/minimal-mistakes/releases/tag/4.10.1)
|
||||
|
|
@ -470,7 +470,7 @@ toc: true
|
|||
### Enhancements
|
||||
|
||||
* "Gemify" theme ~> `gem "minimal-mistakes-jekyll"`
|
||||
* Replace `base_path` include with `absolute_url` filter where possible.
|
||||
* Replace `base_path` include with `relative_url` filter where possible.
|
||||
* Allow images to be placed in other folders. Remove `/images/` only restriction and encourage placement in `/assets/images/` instead. **Full paths are now required. If upgrading from MM 3.4 add `/images/` before filenames in Front Matter and `_config.yml` variables.**
|
||||
* Add [home `layout`](https://github.com/mmistakes/minimal-mistakes/blob/master/_layouts/home.html)
|
||||
* Added missing Turkish translations for UI text. [#621](https://github.com/mmistakes/minimal-mistakes/pull/621)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "2.2 Documentation"
|
||||
permalink: /docs/docs-2-2/
|
||||
excerpt: "Setup and installation instructions for Minimal Mistakes 2.2 (deprecated)."
|
||||
last_modified_at: 2017-10-20T12:37:11-04:00
|
||||
last_modified_at: 2018-03-20T16:00:34-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
|
@ -256,7 +256,7 @@ To include an auto-generated **table of contents** for posts and pages, add the
|
|||
By default the margin below paragraphs has been removed and indent added to each. This is an intentional design decision to mimic the look of type set in a printed book or manuscript.
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/paragraph-indent.png' | absolute_url }}" alt="screen shot of paragraphs with default indent style set">
|
||||
<img src="{{ '/assets/images/paragraph-indent.png' | relative_url }}" alt="screen shot of paragraphs with default indent style set">
|
||||
<figcaption>Example of the default paragraph style (indented first line and bottom margin removed).</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
@ -267,7 +267,7 @@ $paragraph-indent: false;
|
|||
```
|
||||
|
||||
<figure>
|
||||
<img src="{{ '/assets/images/paragraph-no-indent.png' | absolute_url }}" alt="screen shot of paragraphs with indent style disabled">
|
||||
<img src="{{ '/assets/images/paragraph-no-indent.png' | relative_url }}" alt="screen shot of paragraphs with indent style disabled">
|
||||
<figcaption>Example of paragraphs with $paragraph-indent disabled.</figcaption>
|
||||
</figure>
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ layouts_gallery:
|
|||
- url: /assets/images/mm-layout-archive.png
|
||||
image_path: /assets/images/mm-layout-archive.png
|
||||
alt: "archive layout example"
|
||||
last_modified_at: 2018-01-10T11:22:24-05:00
|
||||
last_modified_at: 2018-03-20T16:00:39-04:00
|
||||
toc: true
|
||||
---
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your
|
|||
|
||||
{% include gallery id="layouts_gallery" caption="Examples of included layouts `splash`, `single`, and `archive`." %}
|
||||
|
||||
[Install the Theme]({{ "/docs/quick-start-guide/" | absolute_url }}){: .btn .btn--success .btn--large}
|
||||
[Install the Theme]({{ "/docs/quick-start-guide/" | relative_url }}){: .btn .btn--success .btn--large}
|
||||
|
||||
## Notable Features
|
||||
|
||||
|
|
@ -49,14 +49,14 @@ Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your
|
|||
|
||||
For even more demo pages check the [posts archive][year-archive].
|
||||
|
||||
[header-image-post]: {{ "" | absolute_url }}{% post_url 2012-03-15-layout-header-image-text-readability %}
|
||||
[gallery-post]: {{ "" | absolute_url }}{% post_url 2010-09-09-post-gallery %}
|
||||
[html-tags-post]: {{ "" | absolute_url }}{% post_url 2013-01-11-markup-html-tags-and-formatting %}
|
||||
[syntax-post]: {{ "" | absolute_url }}{% post_url 2013-08-16-markup-syntax-highlighting %}
|
||||
[sample-collection]: {{ "/recipes/chocolate-chip-cookies/" | absolute_url }}
|
||||
[categories-archive]: {{ "/categories/" | absolute_url }}
|
||||
[tags-archive]: {{ "/tags/" | absolute_url }}
|
||||
[year-archive]: {{ "/year-archive/" | absolute_url }}
|
||||
[header-image-post]: {{ "" | relative_url }}{% post_url 2012-03-15-layout-header-image-text-readability %}
|
||||
[gallery-post]: {{ "" | relative_url }}{% post_url 2010-09-09-post-gallery %}
|
||||
[html-tags-post]: {{ "" | relative_url }}{% post_url 2013-01-11-markup-html-tags-and-formatting %}
|
||||
[syntax-post]: {{ "" | relative_url }}{% post_url 2013-08-16-markup-syntax-highlighting %}
|
||||
[sample-collection]: {{ "/recipes/chocolate-chip-cookies/" | relative_url }}
|
||||
[categories-archive]: {{ "/categories/" | relative_url }}
|
||||
[tags-archive]: {{ "/tags/" | relative_url }}
|
||||
[year-archive]: {{ "/year-archive/" | relative_url }}
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ permalink: /sitemap/
|
|||
author_profile: false
|
||||
---
|
||||
|
||||
A list of all the posts and pages found on the site. For you robots out there is an [XML version]({{ "sitemap.xml" | absolute_url }}) available for digesting as well.
|
||||
A list of all the posts and pages found on the site. For you robots out there is an [XML version]({{ "sitemap.xml" | relative_url }}) available for digesting as well.
|
||||
|
||||
<h2>Pages</h2>
|
||||
{% for post in site.pages %}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ tags:
|
|||
---
|
||||
|
||||
{% capture fig_img %}
|
||||
![Foo]({{ "/assets/images/unsplash-gallery-image-3.jpg" | absolute_url }})
|
||||
![Foo]({{ "/assets/images/unsplash-gallery-image-3.jpg" | relative_url }})
|
||||
{% endcapture %}
|
||||
|
||||
<figure>
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ tags:
|
|||
- edge case
|
||||
- image
|
||||
- layout
|
||||
last_modified_at: 2016-11-03T11:45:09-04:00
|
||||
last_modified_at: 2018-03-20T16:00:52-04:00
|
||||
---
|
||||
|
||||
This post should display a **header with an overlay image**, if the theme supports it.
|
||||
|
|
@ -24,7 +24,7 @@ This post tests overlay header images.
|
|||
|
||||
You can use it by specifying the opacity (between 0 and 1) of a black overlay like so:
|
||||
|
||||
![transparent black overlay]({{ "/assets/images/mm-header-overlay-black-filter.jpg" | absolute_url }})
|
||||
![transparent black overlay]({{ "/assets/images/mm-header-overlay-black-filter.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should [...]"
|
||||
|
|
@ -38,7 +38,7 @@ header:
|
|||
|
||||
Or if you want to do more fancy things, go full rgba:
|
||||
|
||||
![transparent red overlay]({{ "/assets/images/mm-header-overlay-red-filter.jpg" | absolute_url }})
|
||||
![transparent red overlay]({{ "/assets/images/mm-header-overlay-red-filter.jpg" | relative_url }})
|
||||
|
||||
```yaml
|
||||
excerpt: "This post should [...]"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Gemified Theme -- Alpha Release"
|
||||
last_modified_at: 2017-10-20T12:29:34-04:00
|
||||
last_modified_at: 2018-03-20T16:00:58-04:00
|
||||
categories:
|
||||
- Jekyll
|
||||
tags:
|
||||
|
|
@ -68,17 +68,17 @@ Run `bundle install` (or `bundle update` if you're updating an existing repo) to
|
|||
|
||||
Add `theme: "minimal-mistakes-jekyll"` to your `_config.yml` file.
|
||||
|
||||
If you're migrating from an existing Minimal Mistakes site you shouldn't have to change anything else after this. If it's a new site consult then docs to [properly config]({{ "/docs/configuration/" | absolute_url }}).
|
||||
If you're migrating from an existing Minimal Mistakes site you shouldn't have to change anything else after this. If it's a new site consult then docs to [properly config]({{ "/docs/configuration/" | relative_url }}).
|
||||
|
||||
**Please Note:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | absolute_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | absolute_url }}) have changed and now require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: assets/images/filename.jpg`. The preferred location is now `assets/images` but can be placed elsewhere or external hosted. This applies for image references in `_config.yml` and `author.yml`.
|
||||
**Please Note:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | relative_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | relative_url }}) have changed and now require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: assets/images/filename.jpg`. The preferred location is now `assets/images` but can be placed elsewhere or external hosted. This applies for image references in `_config.yml` and `author.yml`.
|
||||
{: .notice--danger}
|
||||
|
||||
## Step 5: `jekyll new` Tweaks
|
||||
|
||||
If this is a new site be sure to add the following files to `_data/` and customize as you see fit. There is currently no way of bundling them in with the theme, so be sure to consult the docs on how to properly use both.
|
||||
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | absolute_url }})
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | relative_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | relative_url }})
|
||||
|
||||
You'll also need to:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Gemified Theme -- Beta Release"
|
||||
last_modified_at: 2017-10-20T12:29:16-04:00
|
||||
last_modified_at: 2018-03-20T16:01:04-04:00
|
||||
categories:
|
||||
- Jekyll
|
||||
tags:
|
||||
|
|
@ -52,17 +52,17 @@ Run `bundle install` (or `bundle update` if you're updating an existing repo) to
|
|||
|
||||
Add `theme: "minimal-mistakes-jekyll"` to your `_config.yml` file.
|
||||
|
||||
If you're migrating from an existing Minimal Mistakes site you shouldn't have to change anything else after this. If it's a new site consult then docs to [properly config]({{ "/docs/configuration/" | absolute_url }}).
|
||||
If you're migrating from an existing Minimal Mistakes site you shouldn't have to change anything else after this. If it's a new site consult then docs to [properly config]({{ "/docs/configuration/" | relative_url }}).
|
||||
|
||||
**Please Note:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | absolute_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | absolute_url }}) have changed and now require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: assets/images/filename.jpg`. The preferred location is now `assets/images` but can be placed elsewhere or external hosted. This all applies for image references in `_config.yml` and `author.yml` as well.
|
||||
**Please Note:** Paths for image headers, overlays, teasers, [galleries]({{ "/docs/helpers/#gallery" | relative_url }}), and [feature rows]({{ "/docs/helpers/#feature-row" | relative_url }}) have changed and now require a full path. Instead of just `image: filename.jpg` you'll need to use the full path eg: `image: assets/images/filename.jpg`. The preferred location is now `assets/images` but can be placed elsewhere or external hosted. This all applies for image references in `_config.yml` and `author.yml` as well.
|
||||
{: .notice--danger}
|
||||
|
||||
## Step 5: `jekyll new` Tweaks
|
||||
|
||||
If this is a new site be sure to add the following files to `_data/` and customize as you see fit. There is currently no way of bundling them in with the theme, so be sure to consult the docs on how to properly use both.
|
||||
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | absolute_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | absolute_url }})
|
||||
- [`_data/ui-text.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/ui-text.yml) - UI text [documentation]({{ "/docs/ui-text/" | relative_url }})
|
||||
- [`_data/navigation.yml`](https://github.com/mmistakes/minimal-mistakes/blob/master/_data/navigation.yml) - navigation [documentation]({{ "/docs/navigation/" | relative_url }})
|
||||
|
||||
You'll also need to:
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue