jekyll-collection-pages 0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+https://www.allisonthackston.com/contact/.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to jekyll-collection-pages
+
+Thank you for your interest in contributing to jekyll-collection-pages! We welcome contributions from the community to help improve and grow this project. This document outlines the process for contributing to the repository.
+
+## Getting Started
+
+1. Fork the repository on GitHub.
+2. Clone your fork locally: `git clone https://github.com/PrimerPages/jekyll-collection-pages.git`
+3. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` or `git checkout -b fix/your-bug-fix`
+
+## Making Changes
+
+1. Make your changes in your branch.
+2. Follow the coding style and conventions used in the project.
+3. Add or update tests as necessary.
+4. Ensure all tests pass locally.
+5. Commit your changes with a clear and descriptive commit message.
+
+## Submitting a Pull Request
+
+1. Push your changes to your fork on GitHub.
+2. Open a pull request from your branch to the main repository's `main` branch.
+3. Provide a clear title and description for your pull request, explaining the changes you've made and why.
+4. Be prepared to address any feedback or questions during the review process.
+
+## Reporting Issues
+
+If you find a bug or have a suggestion for improvement:
+
+1. Check if the issue already exists in the GitHub issue tracker.
+2. If not, create a new issue, providing as much detail as possible, including steps to reproduce for bugs.
+
+## Code of Conduct
+
+Please note that this project adheres to a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+
+## Questions?
+
+If you have any questions or need further clarification, please don't hesitate to ask in the issue tracker or reach out to the maintainers.
+
+Thank you for contributing to jekyll-collection-pages!

data/Gemfile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'jekyll', ENV['JEKYLL_VERSION'] if ENV['JEKYLL_VERSION']
+
+gem 'webrick', '~> 1.8'
+
+group :jekyll_plugins do
+  gem 'jekyll-feed'
+  gem 'jekyll-paginate'
+  gem 'jekyll-redirect-from'
+  gem 'jekyll-relative-links'
+  gem 'jekyll-sitemap'
+  gem 'jekyll-theme-profile' # needed for themeing
+end
+
+group :development do
+  gem 'bundler'
+  gem 'dotenv'
+  gem 'html-proofer'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'ruby-lsp'
+  gem 'ruby-lsp-rspec', require: false
+end
+
+# Required in Ruby 3.4+ when Jekyll < 4.4
+gem 'base64'
+gem 'bigdecimal'
+gem 'csv'
+gem 'logger'
+
+# Required in Ruby 3.3.4 when Jekyll == 3.10
+gem 'kramdown-parser-gfm'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Allison Thackston
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+---
+title: "Quick start"
+category: "Getting Started"
+description: "Install the plugin, configure your first collection, and explore the generated pages."
+order: 2
+---
+
+`jekyll-collection-pages` adds automated index pages, layout selection, and optional pagination for any Jekyll collection. In a few minutes you can stand up front-matter key based landing pages like "tags" or "categories" that stay in sync with your content.
+
+## Install the plugin
+
+1. Add the gem to your site’s `Gemfile`:
+
+    ```ruby
+    gem 'jekyll-collection-pages'
+    ```
+
+2. Enable the plugin in `_config.yml`:
+
+    ```yaml
+    plugins:
+      - jekyll-collection-pages
+    ```
+
+3. Ensure the collections you plan to index have `output: true` so the generated pages can link to the documents.
+
+## Configure your first collection
+
+Add a `collection_pages` entry for each collection/field combination you want to index:
+
+```yaml
+collections:
+  docs:
+    output: true
+
+collection_pages:
+  - collection: docs
+    field: category
+    path: docs/category
+    layout: category_layout.html
+    paginate: 6
+```
+
+Key options:
+- `collection`: collection label (matches `collections` config).
+- `field`: front-matter key to group documents (string or list values).
+- `path`: base folder for generated pages (relative to site root).
+- `layout`: layout in `_layouts/` (defaults to `collection_layout.html`).
+- `paginate`: optional integer for per-page pagination.
+
+You can declare multiple entries—single collection with many fields, or multiple collections:
+
+```yaml
+collection_pages:
+  - collection: docs
+    field: category
+    path: docs/category
+    layout: category_layout.html
+    paginate: 6
+  - collection: articles
+    field: tags
+    path: articles/tags
+    layout: tags_layout.html
+    paginate: 10
+```
+
+## Build and explore
+
+Run `bundle exec jekyll serve` and visit the generated paths, e.g. `/docs/category/getting-started/`. The plugin injects these variables into layouts:
+
+- `page.tag`: value of the current field.
+- `page.posts`: documents in that field bucket.
+- `page.paginator`: pagination data when `paginate` is set (same shape as Jekyll paginator).
+
+
+```html
+{% raw %}
+---
+layout: default
+---
+<h1>{{ page.tag }}</h1>
+<ul>
+  {% for doc in page.posts %}
+    <li><a href="{{ doc.url | relative_url }}">{{ doc.data.title }}</a></li>
+  {% endfor %}
+</ul>
+{% endraw %}
+```
+
+## Surface the generated data
+
+Every build populates a hash at `site.data.collection_pages[collection][field]` that contains:
+
+- `template` → the full sanitized template used for creating pages with placeholders intact.  Directory-style values from `_config.yml` are auto-appended with `:field/page:num/index.html`. (e.g. `/docs/category/:field/page:num/index.html`)
+- `permalink` → the sanitized template for the index with placeholders intact (e.g. `/docs/category/:field/`)
+- `pages` → documents grouped by label (`{ label => [documents...] }`)
+- `labels`: metadata describing the generated index pages
+
+Iterate through the documents for a field:
+
+```liquid
+{% raw %}
+{% assign docs_info = site.data.collection_pages.docs.category %}
+{% for entry in docs_info.pages %}
+  {% assign label = entry | first %}
+  {% assign documents = entry | last %}
+  <h2>{{ label }}</h2>
+  <p>{{ documents.size }} docs</p>
+{% endfor %}
+{% endraw %}
+```
+
+Pair the documents with their metadata when you need generated URLs or pagination helpers:
+
+```liquid
+{% raw %}
+{%- assign info = site.data.collection_pages.articles.tags %}
+
+{% for entry in info.pages %}
+  {% assign label = entry | first %}
+  {% assign documents = entry | last %}
+  {% assign meta = info.labels[label] %}
+  <h2> <a href="{{ meta.index.url | relative_url }}">{{ label }}</a> ({{ documents.size }})</h2>
+  <ul>
+  {% for entry in documents %}
+    <li><a href="{{ entry.url }}">{{ entry.title }}</a></li>
+  {% endfor %}
+  </ul>
+{% endfor %}
+{% endraw %}
+```
+
+Or create the links to the generated documents by subsituting the path:
+
+```liquid
+{% raw %}
+{%- assign info = site.data.collection_pages.articles.tags %}
+{%- assign index_permalink = site.data.collection_pages.articles.tags.permalink %}
+
+{% for entry in info.pages %}
+  {% assign label = entry | first %}
+  {% assign documents = entry | last %}
+  {% assign tag_url = index_permalink | replace: ':field', label %}
+  <h2> <a href="{{ tag_url | relative_url }}">{{ label }}</a> ({{ documents.size }})</h2>
+  <ul>
+  {% for entry in documents %}
+    <li><a href="{{ entry.url }}">{{ entry.title }}</a></li>
+  {% endfor %}
+  </ul>
+{% endfor %}
+{% endraw %}
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/demo/CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+../CODE_OF_CONDUCT.md

data/demo/_articles/jekyll-collection-pages-comparison.md

@@ -0,0 +1,90 @@
+---
+layout: post
+title: "Jekyll Collection Pages Comparison"
+date: 2024-08-02
+author: Allison Thackston
+category: Plugin Comparisons
+image: /assets/img/post-img-3.png
+tags: [jekyll, plugins, tagging, categories, collections]
+---
+
+When it comes to organizing content in Jekyll, several plugins offer solutions for handling tags and categories. In this article, we'll compare three popular options: `jekyll-collection-pages`, `jekyll-tagging`, and `jekyll-category-pages`. We'll explore their features, use cases, and help you decide which might be the best fit for your project.
+
+## jekyll-collection-pages
+
+`jekyll-collection-pages` is a versatile plugin that generates pages for tags or categories across multiple collections.
+
+### Key Features:
+- Works with any Jekyll collection, not just posts
+- Supports both tags and categories in a single configuration
+- Offers pagination for generated pages
+- Allows custom layouts for different collections
+- Provides flexibility in URL structure
+
+### Use Case:
+Ideal for sites with multiple content types (e.g., blog posts, documentation, projects) that need consistent tag/category pages across all collections.
+
+## jekyll-tagging
+
+jekyll-tagging is a long-standing plugin focused specifically on generating tag pages for posts.
+
+### Key Features:
+- Generates tag pages for blog posts
+- Creates a tag cloud
+- Allows for custom tag page layouts
+- Supports tag pagination (with additional configuration)
+
+### Use Case:
+Best for blogs or simple sites that only need tag functionality for posts and want features like tag clouds.
+
+## jekyll-category-pages
+
+jekyll-category-pages is designed to generate category archive pages for Jekyll sites.
+
+### Key Features:
+- Creates category archive pages
+- Supports custom layouts for category pages
+- Works with Jekyll's native category system
+- Generates an overall categories index page
+
+### Use Case:
+Suited for sites that primarily use categories for organization and want dedicated category archive pages.
+
+## Comparison
+
+| Feature | jekyll-collection-pages | jekyll-tagging | jekyll-category-pages |
+|---------|-------------------------|----------------|------------------------|
+| Works with all collections | ✅ | ❌ (posts only) | ❌ (posts only) |
+| Tag support | ✅ | ✅ | ❌ |
+| Category support | ✅ | ❌ | ✅ |
+| Pagination | ✅ | ✅ | ❌ |
+| Custom layouts | ✅ | ✅ | ✅ |
+| Tag cloud | ❌ | ✅ | N/A |
+| Categories index | ✅ | N/A | ✅ |
+
+## When to Choose Each Plugin
+
+1. **Choose jekyll-collection-pages if:**
+   - You have multiple collections and want consistent tag/category pages across all of them
+   - You need flexibility in handling both tags and categories
+   - You want built-in pagination support
+
+2. **Choose jekyll-tagging if:**
+   - You only need to handle tags for blog posts
+   - You want a tag cloud feature
+   - You're okay with additional configuration for pagination
+
+3. **Choose jekyll-category-pages if:**
+   - You primarily use categories for organizing your posts
+   - You don't need tag support
+   - You want a simple solution focused solely on category pages
+
+## Conclusion
+
+While all three plugins offer valuable functionality, Jekyll Collection Pages stands out for its flexibility and comprehensive approach to handling both tags and categories across all collections. It's particularly powerful for sites with diverse content types that need a unified system for content organization.
+
+jekyll-tagging remains a solid choice for blogs focused on tag-based navigation, especially if you want features like tag clouds. jekyll-category-pages is best suited for sites that primarily use categories and don't require tag functionality.
+
+Ultimately, the best choice depends on your specific needs. Consider your site structure, the importance of tags vs categories, and whether you need to organize content beyond just blog posts when making your decision.
+
+Remember, you can always start with a simpler solution and migrate to a more comprehensive one as your site grows and your needs evolve.

data/demo/_articles/jekyll-collection-pages-indices.md

@@ -0,0 +1,173 @@
+---
+layout: post
+title: "Generate Index Pages from Your Jekyll Collections"
+date: 2025-11-10
+author: Allison Thackston
+tags: [jekyll, plugins, collections, pagination, releases]
+image: /assets/img/post-img-4.png
+description: "Introducing automated collection index pages with site.data.collection_pages"
+---
+
+The latest release of **`jekyll-collection-pages`** introduces a new way to **generate index pages automatically** for any Jekyll collection.  
+Define one simple configuration, and the plugin creates organized, linkable index pages for every unique value of a chosen field — such as `category`, `tags`, or any custom key.
+
+## What It Does
+
+Until now, creating index pages for collections meant writing a custom generator or manually duplicating layouts.  
+With this release, the plugin can now:
+
+- Build one index page per unique field value  
+- Paginate results automatically  
+- Expose a structured dataset in `site.data.collection_pages` for custom UIs  
+
+That means you can create browsable directories like:
+
+```
+/docs/category/getting-started/
+/docs/category/reference/
+/docs/category/usage/
+```
+
+All without writing a single custom generator.
+
+
+## Quick Start
+
+In your `_config.yml`, define the behavior for your collection under `collection_pages`:
+
+```yaml
+collection_pages:
+  collection: docs
+  field: category
+  path: docs/category
+  layout: collection_layout.html
+  paginate: 5
+```
+
+Then rebuild your site:
+
+```bash
+bundle exec jekyll build
+```
+
+You’ll find generated pages under `_site/docs/category/<slug>/index.html` — one folder per unique `category` value.  
+If you specify `paginate`, the plugin creates additional pages that follow the template (e.g. `/docs/category/getting-started/page2/`) and exposes previous/next links via `page.paginator`.
+
+
+## Generated Data Reference
+
+Every run exports metadata into `site.data.collection_pages`, mirroring Jekyll’s built-in `site.tags` and `site.categories`.
+
+```liquid
+{% raw %}
+site.data.collection_pages[collection][field]
+{% endraw %}
+```
+
+Each entry includes:
+
+- `template` → the full sanitized template used for creating pages with placeholders intact.  Directory-style values from `_config.yml` are auto-appended with `:field/page:num/index.html`. (e.g. `/docs/category/:field/page:num/index.html`)
+- `permalink` → the sanitized template for the index with placeholders intact (e.g. `/docs/category/:field/`)
+- `pages` → documents grouped by label (`{ label => [documents...] }`)
+- `labels`: metadata describing the generated index pages
+
+### pages
+
+Groups documents by label:
+
+```liquid
+{% raw %}
+{% assign info = site.data.collection_pages.docs.category %}
+{% for entry in info.pages %}
+  {% assign label = entry | first %}
+  {% assign documents = entry | last %}
+  <h2>{{ label }} ({{ documents.size }})</h2>
+  <ul>
+    {% for doc in documents %}
+      <li><a href="{{ doc.url | relative_url }}">{{ doc.data.title }}</a></li>
+    {% endfor %}
+  </ul>
+{% endfor %}
+{% endraw %}
+```
+
+### labels
+
+Provides metadata for each generated index:
+
+- `index`: first generated index page (`index.html`)
+- `pages`: all generated index pages (if paginated)
+
+Example:
+
+```liquid
+{% raw %}
+## Index of generated pages
+{%- assign index_by_label = site.data.collection_pages.docs.category.labels %}
+
+{% for entry in index_by_label %}
+  {% assign label = entry | first %}
+  {% assign info = entry | last %}
+  <h2> <a href="{{ info.index.url | relative_url }}">{{ label }}</a> ( {{ info.pages.size }})</h2>
+  <ul>
+  {% for entry in info.pages %}
+    <li><a href="{{ entry.url }}">Page {{ entry.page_num }}</a></li>
+  {% endfor %}
+  </ul>
+{% endfor %}
+{% endraw %}
+```
+
+## Example Layout
+
+Here’s a minimal `collection_layout.html` template:
+
+```html
+---
+layout: default
+---
+
+<h1>{{ page.title }}</h1>
+
+<ul>
+  {% for post in page.posts %}
+    <li><a href="{{ post.url }}">{{ post.data.title }}</a></li>
+  {% endfor %}
+</ul>
+
+{% if page.paginator %}
+  <nav>
+    {% if page.paginator.previous_page %}
+      <a href="{{ page.paginator.previous_page_path | relative_url }}">Previous</a>
+    {% endif %}
+    {% if page.paginator.next_page %}
+      <a href="{{ page.paginator.next_page_path | relative_url }}">Next</a>
+    {% endif %}
+  </nav>
+{% endif %}
+```
+
+`page.paginator.previous_page_path` and `page.paginator.next_page_path` already contain the tag directory (for example `docs/category/reference/` or `docs/category/reference/page2.html`), so passing them through `relative_url` is enough to produce correct links.
+
+---
+
+## Debugging and Development Tips
+
+- Dump the full structure with `{% raw %}{{ site.data.collection_pages | jsonify }}{% endraw %}`  
+- Enable debug logging:  
+  ```bash
+  JEKYLL_LOG_LEVEL=debug bundle exec jekyll build
+  ```
+- Check field names for case sensitivity — missing labels usually indicate a typo or inconsistent field key.
+
+---
+
+## Why It Matters
+
+This feature bridges the gap between Jekyll’s **collections** and **taxonomy-style browsing**, enabling:
+
+- Documentation sites with sectioned navigation  
+- Blogs organized by topic or author  
+- Paginated directories of any custom field  
+
+No manual duplication, no custom Liquid loops — just configuration.