diff --git a/CHANGELOG.md b/CHANGELOG.md index 88f54bc3..004fb260 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,8 +4,10 @@ - Add `.page__comments-form` to "non-printing" selectors in print styles. [#1195](https://github.com/mmistakes/minimal-mistakes/pull/1195) - Add LinkedIn and Steam author sidebar examples to `_config.yml`. [#1203](https://github.com/mmistakes/minimal-mistakes/pull/1203) [#1204](https://github.com/mmistakes/minimal-mistakes/pull/1204) -- Clarify documentation for `jekyll-archives` plugin and how to install. [#1206](https://github.com/mmistakes/minimal-mistakes/pull/1206) [#811](https://github.com/mmistakes/minimal-mistakes/issues/811) - Remove the http-equiv="cleartype" meta tag. [#1087](https://github.com/mmistakes/minimal-mistakes/pull/1087) +- Clarify documentation for `jekyll-archives` plugin and how to install. [#1206](https://github.com/mmistakes/minimal-mistakes/pull/1206) +- Clarify documentation around taxonomy page and index generation. [#1207](https://github.com/mmistakes/minimal-mistakes/pull/1207) +- Fix "Posts by tag" grammar in documentation. [#1209](https://github.com/mmistakes/minimal-mistakes/pull/1209) ### Bug Fixes diff --git a/README.md b/README.md index 175553dc..f669daa4 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ See what's new in the [CHANGELOG](CHANGELOG.md). | [Post with a Gallery][gallery-post] | A post showing several images wrapped in `
` elements. | | [Sample Collection Page][sample-collection] | Single page from a collection. | | [Categories Archive][categories-archive] | Posts grouped by category. | -| [Tags Archive][tags-archive] | Posts grouped by tags. | +| [Tags Archive][tags-archive] | Posts grouped by tag. | Additional sample posts are available under [posts archive][year-archive] on the demo site. Source files for these (and the entire demo site) can be found in [`/docs`](docs). diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 16a2e948..c2f940c6 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -588,10 +588,9 @@ 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`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/category-archive.html) and [`/tags/index.html`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/tag-archive.html). The necessary Liquid code to build these pages can be taken from the demo site. -{: .notice--warning} +**Note:** these are simply hash (fragment) links into the full taxonomy index pages. For them to resolve properly, the category and tag index pages need to exist at [`/categories/index.html`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/category-archive.html) (copy to `_pages/category-archive.html`) and [`/tags/index.html`](https://github.com/{{ site.repository }}/blob/master/docs/_pages/tag-archive.html) (copy to `_pages/tag-archive.html`). {: .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. +If you have the luxury of using Jekyll Plugins, then [**jekyll-archives**][jekyll-archives] will create a better experience as discrete taxonomy pages would be generated, and their corresponding links would be "real" (not just hash/fragment links into a larger index). However, the plugin will not generate the taxonomy index pages (`category-archive.html` and `_pages/tag-archive.html`) so you'd still need to manually create them if you'd like to have them (see note above). First, you'll need to make sure that the `jekyll-archives` plugin is installed. Either run `gem install jekyll-archives` or add the following to your `Gemfile`: ``` diff --git a/docs/_docs/10-layouts.md b/docs/_docs/10-layouts.md index 39f8b288..9f624f0b 100644 --- a/docs/_docs/10-layouts.md +++ b/docs/_docs/10-layouts.md @@ -101,7 +101,7 @@ Essentially the same as `single` with markup adjustments and some modules remove Below are sample archive pages you can easily drop into your project, taking care to rename `permalink`, `title`, or the filename to fit your site. Each is 100% compatible with GitHub Pages. * [All Posts Grouped by Category -- List View][posts-categories] -* [All Posts Grouped by Tags -- List View][posts-tags] +* [All Posts Grouped by Tag -- List View][posts-tags] * [All Posts Grouped by Year -- List View][posts-year] * [All Posts Grouped by Collection -- List View][posts-collection] * [Portfolio Collection -- Grid View][portfolio-collection] @@ -179,7 +179,7 @@ The **Tags Archive** page that responds to urls such as `/tags/#tips` looks some --- layout: archive permalink: /tags/ -title: "Posts by Tags" +title: "Posts by Tag" author_profile: true --- diff --git a/docs/_docs/14-helpers.md b/docs/_docs/14-helpers.md index 25814b2f..849417ef 100644 --- a/docs/_docs/14-helpers.md +++ b/docs/_docs/14-helpers.md @@ -57,7 +57,7 @@ The Liquid based taxonomy archives found amongst the demo pages rely on this hel | Description | | | | ----------- | ------------------------ | --------------------------- | | All posts grouped by category | [Source][category-array] | [Demo][category-array-demo] | -| All posts grouped by tags | [Source][tag-array] | [Demo][tag-array-demo] | +| All posts grouped by tag | [Source][tag-array] | [Demo][tag-array-demo] | [category-array]: https://github.com/{{ site.repository }}/blob/master/docs/_pages/category-archive.html [category-array-demo]: {{ "/categories/" | absolute_url }} diff --git a/docs/_docs/18-history.md b/docs/_docs/18-history.md index f072ddf0..97af9dff 100644 --- a/docs/_docs/18-history.md +++ b/docs/_docs/18-history.md @@ -13,8 +13,10 @@ last_modified_at: 2017-08-29T15:40:03-04:00 - Add `.page__comments-form` to "non-printing" selectors in print styles. [#1195](https://github.com/mmistakes/minimal-mistakes/pull/1195) - Add LinkedIn and Steam author sidebar examples to `_config.yml`. [#1203](https://github.com/mmistakes/minimal-mistakes/pull/1203) [#1204](https://github.com/mmistakes/minimal-mistakes/pull/1204) -- Clarify documentation for `jekyll-archives` plugin and how to install. [#1206](https://github.com/mmistakes/minimal-mistakes/pull/1206) [#811](https://github.com/mmistakes/minimal-mistakes/issues/811) - Remove the http-equiv="cleartype" meta tag. [#1087](https://github.com/mmistakes/minimal-mistakes/pull/1087) +- Clarify documentation for `jekyll-archives` plugin and how to install. [#1206](https://github.com/mmistakes/minimal-mistakes/pull/1206) +- Clarify documentation around taxonomy page and index generation. [#1207](https://github.com/mmistakes/minimal-mistakes/pull/1207) +- Fix "Posts by tag" grammar in documentation. [#1209](https://github.com/mmistakes/minimal-mistakes/pull/1209) ### Bug Fixes diff --git a/docs/_pages/about.md b/docs/_pages/about.md index 2eafe3fd..24b1c988 100644 --- a/docs/_pages/about.md +++ b/docs/_pages/about.md @@ -42,7 +42,7 @@ Minimal Mistakes is a flexible two-column Jekyll theme. Perfect for hosting your | [Post with a Gallery][gallery-post] | A post showing several images wrapped in `
` elements. | | [Sample Collection Page][sample-collection] | Single page from a collection. | | [Categories Archive][categories-archive] | Posts grouped by category. | -| [Tags Archive][tags-archive] | Posts grouped by tags. | +| [Tags Archive][tags-archive] | Posts grouped by tag. | For even more demo pages check the [posts archive][year-archive]. diff --git a/docs/_pages/tag-archive.html b/docs/_pages/tag-archive.html index df086808..b30a57f5 100644 --- a/docs/_pages/tag-archive.html +++ b/docs/_pages/tag-archive.html @@ -1,7 +1,7 @@ --- layout: archive permalink: /tags/ -title: "Posts by Tags" +title: "Posts by Tag" author_profile: true --- @@ -13,4 +13,4 @@ author_profile: true {% for post in posts %} {% include archive-single.html %} {% endfor %} -{% endfor %} \ No newline at end of file +{% endfor %} diff --git a/test/_pages/tag-archive.html b/test/_pages/tag-archive.html index 4006381d..75833cda 100644 --- a/test/_pages/tag-archive.html +++ b/test/_pages/tag-archive.html @@ -1,7 +1,7 @@ --- layout: archive permalink: /tags/ -title: "Posts by Tags" +title: "Posts by Tag" author_profile: true --- @@ -14,4 +14,4 @@ author_profile: true {% for post in posts %} {% include archive-single.html %} {% endfor %} -{% endfor %} \ No newline at end of file +{% endfor %}