jekyll-documents

Turn files in assets/documents/ into browsable document pages.

Features: Auto-collection • File icons • Categories • Search

# Gemfile
gem "jekyll-documents"

# _config.yml
plugins:
  - jekyll-documents

documents:
  icon_set: "color"  # color, lines, minimal, ultra-minimal

# Add files
assets/documents/reports/2026-03-01_Annual_Report.pdf
assets/documents/minutes/2026-02-15_Board_Meeting.docx

<!-- Use in templates -->
{% include latest_documents.html %}
{% include documents_list.html %}
{% include category_list.html %}

Format: YYYY-MM-DD_Title.ext

assets/documents/reports/2026-03-01_Annual_Report.pdf

Date → YYYY-MM-DD • Title → underscores to spaces • Category → folder name

4 icon sets: color (default), lines, minimal, ultra-minimal

documents:
  icon_set: "color"

{{ page.file_type | file_type_icon_tag }}

{% include latest_documents.html count=5 %}
{% include documents_list.html %}
{% include documents_search.html %}

documents:
  root: "assets/documents"
  icon_set: "color"
  strict_filename: true

See configuration.rb for all options.

rake              # All quality checks
rake quick        # Fast check
rake help         # Show commands

Quality: 98.99% coverage • 0 vulnerabilities • RuboCop • Reek

See README.Development.md for details.

./bump_version.sh patch
./release.sh

AGPL-3.0-only • Icons by SVG Repo