Skip to content

Replace just-the-docs with custom Solr-branded Jekyll theme#25

Merged
janhoy merged 1 commit into
apache:mainfrom
janhoy:custom-jekyll-theme
May 24, 2026
Merged

Replace just-the-docs with custom Solr-branded Jekyll theme#25
janhoy merged 1 commit into
apache:mainfrom
janhoy:custom-jekyll-theme

Conversation

@janhoy
Copy link
Copy Markdown
Contributor

@janhoy janhoy commented May 24, 2026

Replaces the just-the-docs gem (not on GitHub Pages' safe gem list) with a zero-external-gem custom theme, enabling docs publishing via .asf.yaml's ghp_branch/ghp_path — no GitHub Actions workflow required.

What changed

  • Custom Jekyll theme styled after the Solr identity: Raleway font, #D9411E orange, #262130 navy
  • 3-level sidebar nav auto-built from existing nav_order/parent/grand_parent front matter — no content changes needed
  • Client-side search, breadcrumbs, callout blocks, mobile responsive layout
  • .asf.yaml: added ghp_branch: main + ghp_path: /docs to enable GitHub Pages
  • Removed docs.yml Actions workflow (GitHub's built-in Jekyll builder handles it now)
  • Gemfile: gem "jekyll" only
solr-orbit-docs-screenshot

https://issues.apache.org/jira/browse/SOLR-18261

Removes the just-the-docs gem (not on GitHub Pages safe list) and
replaces it with a zero-external-gem custom theme styled after the
official Solr identity (Raleway font, #D9411E orange, #262130 navy).

Enables GitHub Pages via .asf.yaml ghp_branch/ghp_path, eliminating
the need for a GitHub Actions docs workflow.

- Custom _layouts/default.html with header, sidebar, footer
- 3-level nav tree from nav_order/parent/grand_parent front matter
- Solr logo, search, breadcrumbs, callout blocks, back-to-top
- Mobile responsive sidebar
@janhoy janhoy requested a review from epugh May 24, 2026 23:25
@janhoy janhoy merged commit d9a005e into apache:main May 24, 2026
3 checks passed
@janhoy janhoy deleted the custom-jekyll-theme branch May 24, 2026 23:52
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.

1 participant