Add documented cases of jekyll-archives in use

[opattison]

One issue I ran into when initially configuring jekyll-archives was not having any point of reference for either typical or advanced uses. I searched quite a bit on Google and GitHub for people using it and did not come up with anything useful. In particular, I was looking for even a single person using it, so that I could troubleshoot and check my initial configuration. I know this project is relatively new, so that means it is difficult to find many use cases yet, but I had no luck finding a working example at all.

Searching for examples is currently not easy because similar but less comprehensive efforts of hacking archives into Jekyll or GitHub Pages dominate Google search results for a term like “jekyll archives” (alongside a few links to this repo).

I don’t have any complaints about the usefulness of the docs in general, but they might benefit from having a list of good implementations, much like Jekyll has in its official documentation.

[parkr]

This is a great idea. Having a set of use cases provides not only usage instructions by example, but also a set of use cases we wish to write for. This was proposed by mojombo for Jekyll itself a while ago, but I never got around to it. It's basically sketching out what the purpose of the project is – what purpose it fulfills.

:+1:

[opattison]

@parkr I am glad to hear that. I will post recommendations here if I come across them, but I can't find any yet.

[paulrobertlloyd]

I am using this plugin on my (still, but almost completed) redesigned website. Here are the templates:

• https://github.com/paulrobertlloyd/paulrobertlloyd.com/blob/master/source/_layouts/archive-month.html
• https://github.com/paulrobertlloyd/paulrobertlloyd.com/blob/master/source/_layouts/archive-tag.html
• https://github.com/paulrobertlloyd/paulrobertlloyd.com/blob/master/source/_layouts/archive-year.html
• https://github.com/paulrobertlloyd/paulrobertlloyd.com/blob/master/source/_layouts/index.html
• https://github.com/paulrobertlloyd/paulrobertlloyd.com/blob/master/source/_includes/html/structure/page__header.html

(Looking at the year archive template now, wondering if I can simplify the code. Anyway.)

A good way to see who is using this plugin might be to search for gem 'jekyll-archives'.

No idea if mine is a good implementation though ;-)

[opattison]

I finally got my development version of my site using jekyll-archives published on my website. I don’t think mine is a typical use case, but it is a fairly minimal implementation with only two layouts so far:

• category and tags layout
• year and year-month layout
• archive-item include used in both
• main archive layout (parent of the other layouts)

In use: http://olivermak.es/writing/archive/

Process to get it working: https://github.com/opattison/olivermakes/pull/136

Thanks for the source reference @paulrobertlloyd – I might want to borrow a few of your markup/liquid ideas when I get to the next stage with mine.

[gboone]

18F is using this plugin on https://18f.gsa.gov as you can see in our config.yml file