Skip to content

feat: introduce the Jackal Jekyll theme - #2

Open
ReenigneArcher wants to merge 5 commits into
masterfrom
codex/initial-theme
Open

ReenigneArcher wants to merge 5 commits into
masterfrom
codex/initial-theme

Conversation

@ReenigneArcher

@ReenigneArcher ReenigneArcher commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Description

Add Jackal, a shared Jekyll theme for LizardByte, its subprojects, and sites in other GitHub organizations. It supplies layouts for product pages, a project hub, articles, the blog, and catalogs, with configurable branding, navigation, color modes, and the LizardByte wordmark footer.

Project links follow each site's baseurl. Umbrella links can point at a separate domain or the root of a shared preview, independently of the project path. Catalog data and behavior stay with the consuming site.

The example site covers Sunshine, Themerr, Koko, a blog, and a searchable release catalog. The repository's template license remains a publishing decision.

The callable build workflow uses the site's Gemfile on Ruby 4.0 by default. It accepts generated site inputs and packages the rendered files for GitHub Pages. For PRs, it publishes the exact build as an artifact and posts PowerShell and Bash commands that serve it in Docker. The preview retains the site's configured subpath, and the comment workflow can also report successful builds from forks.

Screenshot

Sunshine product example in light mode.

Sunshine product page using the Jackal theme

Issues Fixed or Closed

Roadmap Issues

Testing

  • Built all eight example pages with Jekyll 3.10 and 4.4 at both a domain root and a nested preview path.
  • Verified project and umbrella URLs, canonical links, theme assets, and the published catalog JSON.
  • Checked the Sunshine layout at desktop and mobile widths, switched color modes and screenshots, and verified that catalog filtering handles matching and empty results.
  • Built the theme gem locally and checked the staged diff for whitespace errors.
  • Tested the workflow build for root and nested previews and checked the Pages output keeps the site at its artifact root.
  • Tested generated input from ZIP, TAR.GZ, and directory artifacts, plus comment selection for forks, stale heads, and reruns.
  • YAML lint, flake8, and actionlint passed locally.
  • GitHub Actions downloaded the rendered artifact, served it with Docker, and posted the preview command on this PR.

Type of Change

  • feat: New feature (non-breaking change which adds functionality)
  • fix: Bug fix (non-breaking change which fixes an issue)
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.)
  • refactor: Code change that neither fixes a bug nor adds a feature
  • perf: Code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • build: Changes that affect the build system or external dependencies
  • ci: Changes to CI configuration files and scripts
  • chore: Other changes that don't modify src or test files
  • revert: Reverts a previous commit
  • BREAKING CHANGE: Introduces a breaking change (can be combined with any type above)

Checklist

  • Code follows the style guidelines of this project
  • Code has been self-reviewed
  • Code has been commented, particularly in hard-to-understand areas
  • Code docstring/documentation-blocks for new or existing methods/components have been added or updated
  • Tests have been added or updated for new or modified functionality, including regression tests for bug fixes

AI Usage

See our AI usage policy.

  • AI tools were used while preparing this PR

pull-requests: write
steps:
- name: Checkout the comment workflow tools
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
@github-actions

github-actions Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Preview this build

Commit a4419cbd147e1c6137649325ede0d7e26d367b88 · CI run 44659059304, attempt 1

With Docker running and GitHub CLI signed in, paste one command:

PowerShell

$preview = Join-Path ([IO.Path]::GetTempPath()) ("jackal-" + [guid]::NewGuid()); gh run download 44659059304 --repo LizardByte/jackal --name jackal-preview-a4419cbd147e1c6137649325ede0d7e26d367b88-1 --dir "$preview"; if ($LASTEXITCODE -eq 0) { docker run --rm -p 127.0.0.1:8080:80 --mount "type=bind,source=$preview,target=/usr/share/nginx/html,readonly" nginx:alpine }

Bash or Zsh

preview="$(mktemp -d)" && gh run download 44659059304 --repo LizardByte/jackal --name jackal-preview-a4419cbd147e1c6137649325ede0d7e26d367b88-1 --dir "$preview" && docker run --rm -p 127.0.0.1:8080:80 --mount "type=bind,source=$preview,target=/usr/share/nginx/html,readonly" nginx:alpine

Open localhost:8080. Stop the server with Ctrl+C.
The download is retained by GitHub Actions for up to 14 days.

@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
15 New issues
C Reliability Rating on New Code (required ≥ A)
C Security Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants