# github/pages-gem

A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages

Repository: https://github.com/github/pages-gem
Canonical: https://ross.abutalabs.com/products/pages-gem
Homepage: http://pages.github.com
Language: Ruby
License: MIT
License Family: permissive
Topics: jekyll, ruby, ruby-gem, jekyll-plugin, jekyll-theme, github, github-pages
Last push: 2025-03-03T18:20:47+00:00

## Health v2 (maintenance only)
Score: 27/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 9, release rhythm 8, longevity 100
- inputs: {"age_days": 4773, "days_push": 548, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1873, forks 359 (observed 2026-08-28T04:05:47.118935+00:00)

## What it is
A Ruby gem that bundles the exact dependency versions Jekyll, plugins, and themes used by GitHub Pages, so a local Jekyll environment matches production. It also offers a Docker-based setup for previewing sites locally.

## Use cases
- preview my GitHub Pages site locally before pushing
- set up a local Jekyll environment matching GitHub Pages
- install Jekyll with the right plugin versions
- run a local server for my GitHub Pages site
- avoid version mismatches between local Jekyll and GitHub Pages
- bootstrap Jekyll dependencies via Bundler

## When to choose
- you build or maintain a site hosted on GitHub Pages with Jekyll
- you want local builds to match GitHub Pages' production environment exactly
- you prefer a Docker-based preview without installing Ruby dependencies

## When to avoid
- you use a static site generator other than Jekyll
- you deploy Jekyll to your own server with custom plugin versions
- you need features or plugins not supported by GitHub Pages

## Facets
- artifact type: library
- maturity: active
- function: static-site-generator, build-tool, package-manager, cli
- domain: web-development, developer-tools, documentation, cms
- platform: ruby, cli, cross-platform
- tags: jekyll, github-pages, ruby-gem, static-sites, local-preview, dependency-management, docker

## Member repositories
- github/pages-gem (main) score 27

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:47.118935+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:14:49.803908+00:00, confidence not recorded.
  - readme: https://github.com/github/pages-gem (fetched 2026-08-28T04:05:47.118935+00:00, sha 60fdf0d0b2ce)
  - homepage: http://pages.github.com (fetched 2026-08-29T10:53:44.204361+00:00, sha ad27f7e1364b)
- Data as of 2026-08-30T08:39:29.467469+00:00.