Skip to content

Releases: HELIX-Origin/helix-jekyll-theme

HELIX Jekyll Theme v1.1.0

Choose a tag to compare

@PhantomNimbi PhantomNimbi released this 17 Oct 11:59

HELIX Jekyll Theme v1.1.0

Modern, multi-layout Jekyll remote theme engine with first-class multi-collection support and modular component partials.

Attribute Value
Release Version v1.1.0
Release Date 2026-10-17
Release Classification Zero-Asset Source Release
License BSD-3-Clause
Release Channel Production / Stable

?? Overview

Version 1.1.0 of the HELIX Jekyll Theme expands the theme engine to fully support the organization's centralized Documentation (docs) and Technical Wiki (wiki) hub architecture. It introduces dynamic support for projects and catalogue collections across all navigation, sidebar, breadcrumb, and pager partials, alongside universal BSD 3-Clause license synchronization.


? Highlights

  • First-Class Collection Architecture ? Full automated discovery and navigation generation for projects and catalogue collections across layouts.
  • Enhanced Breadcrumb & Sequential Pagers ? Dynamic category root resolution and multi-tier breadcrumb trails.
  • Minimal Entry Point Support ? Harmonized navbar links and footer icons linking seamlessly between Docs, Wiki, and Portal hubs.
  • Precompiled Dart Sass ? Zero-compilation client footprint with precompiled CSS and hardware-accelerated transforms.

?? Distribution & Packaging

Note

Zero-Asset Source Release: In accordance with organization release policy, this repository does not publish prebuilt binary assets. Consume via GitHub Pages remote theme or RubyGems:

yaml remote_theme: HELIX-Origin/helix-jekyll-theme


?? What's Changed

?? Added

  • Support for site.projects and site.catalogue across navbar.html, breadcrumbs.html, children_nav.html, sidebar.html, and wiki.html.
  • Centralized hub cross-links in the sidebar footer.

??? Security, Hygiene & Compliance

  • Canonical GitHub BSD 3-Clause license file deployed.
  • Synchronized standard HTML badges with explicit dimension controls.
  • Ruby 3.3+ compatibility gems (rexml, webrick).

HELIX Docs v1.0.0

Choose a tag to compare

@PhantomNimbi PhantomNimbi released this 10 Oct 07:02

HELIX Docs v1.0.0

Release date: 2026-10-10
Version Type: Semantic Versioning (v1.0.0)

✨ Highlights

Initial production release of HELIX Docs, a modern, multi-layout GitHub Pages Jekyll theme engineered for developer documentation, technical wikis, component showcases, and project portals.

HELIX Docs provides an adaptable documentation platform decoupled from specific organization repositories. It features frontmatter-driven hierarchical navigation (up to 3 levels: document, parent, grandparent), full GitHub Pages remote_theme compatibility, modular Dart Sass styling, Mermaid diagram support, and an integrated 18-language client-side Google Translate switcher.

🚀 Key Improvements & Features

  • Frontmatter-Driven Navigation — Fully decoupled from hardcoded navigation data files. Hierarchy, breadcrumbs, sidebar trees, and previous/next page linkers are computed dynamically via parent, grand_parent, nav_order, and permalink frontmatter.
  • Nine Specialized Layouts — Modular templates designed for technical documentation ecosystems:
    • default: Organization and landing portal shell.
    • home: Portal landing layout.
    • wiki: Just-the-docs style 3-level sidebar hierarchy with breadcrumbs and pagers.
    • docs: Documentation layout delegating to full wiki navigation.
    • catalogue & catalogue-item: Multi-item showcases with live filter controls.
    • store & store-item: Software and package showcase cards.
    • changelog: Chronological release milestone timeline.
    • faq: Accessible accordion interface with live search.
  • Modular SCSS Architecture — Split into modular partials (support, modules, color_schemes, vendor, custom) compiled with modern Dart Sass (sass-embedded) and distributed with precompiled assets/css/site.css for zero-configuration GitHub Pages usage.
  • Client-Side Translation System — Built-in 18-language switcher (translate.js + translate-control.html) with robust fallback defaults when local language configuration is absent.
  • Interactive Mermaid Diagrams — Native support for legible GitHub Flavored Markdown ```mermaid fences powered by mermaid.js.
  • Standardized Community Health — Pre-configured YAML GitHub Issue forms (.github/ISSUE_TEMPLATE/) for bug reports, feature proposals, and documentation updates.

✅ Changed

  • Restructured entire theme component model to mirror clean just-the-docs structure (_includes/components/).
  • Standardized Kramdown markdown parsing with parse_block_html: true to support modular flush-left HTML block structures.
  • Streamlined configuration scopes in _config.yml using canonical {path: "", type: ...} matching.

🐛 Fixed

  • Collection Navigation Matching — Resolved sidebar navigation dropping collection documents by implementing robust collection URL and path normalization in nav.html.
  • Collection Index Permalinks — Resolved 404 routing on /docs/ and /wiki/ by enforcing explicit directory permalinks on collection index pages.
  • Kramdown HTML Indentation — Fixed landing section card formatting by removing 4-space code block indent interpretations on raw HTML blocks.

🔍 Platform / Compatibility Matrix

Environment / Dependency Version Requirement Status
GitHub Pages (remote_theme) HELIX-Origin/helix-docs ✅ Verified & Supported
Ruby 3.3.x / 3.2.x ✅ Tested on Ruby 3.3.12
Jekyll >= 3.9, < 5.0 ✅ Verified on Jekyll 3.10.0
Sass Compiler Dart Sass (sass-embedded ~> 1.105) ✅ Verified (precompiled CSS included)
Browsers Chromium, Firefox, Safari, Edge ✅ Fully Responsive

🛠️ Build, Installation & Verification

There are no prebuilt compiled binary packages to download. To consume the theme in any GitHub Pages site:

GitHub Pages remote_theme Usage

Add to your site's _config.yml:

remote_theme: HELIX-Origin/helix-docs
plugins:
  - jekyll-remote-theme

Local Preview Build

$env:PATH = "C:\Ruby33-x64\bin;$env:PATH"
bundle install
bundle exec jekyll build

Verification Results

  • bundle exec jekyll build — passed (0 errors, 0 warnings, site generated in < 1s)
  • Dart Sass CSS Parity — 432/432 legacy CSS rules preserved with full nested-nav support (46,118 bytes compressed)
  • Frontmatter schema validation — verified across all 9 layout templates and collection documents

📄 Changes & Commits

  • 90c608b feat: add YAML issue templates for bugs, features, and documentation
  • b5784e3 fix(theme): use wiki layout for docs collection and restore section cards in index
  • 732a4b3 fix(layout): restore vCard landing structure in default layout and home layout
  • a478638 feat: restructure theme architecture and adopt frontmatter-driven navigation
  • 455b389 Add workflow to purge failed and cancelled GitHub Actions runs
  • 6e76346 Fix 404 on /docs/ and /wiki/: specify permalink /docs/ and /wiki/ for collection index pages
  • 3519c00 Fix GitHub Pages build: remove unwhitelisted _scss dir, remove duplicate custom scss files, and clean entrypoints
  • fdcf426 Add social_image support in head metadata and include precompiled site.css alongside scss
  • 75abb3f Document all 9 supported layouts with frontmatter schemas across documentation
  • e62fb8d Remove external project references from documentation
  • 2c43ff9 Support custom.scss and setup.scss in _sass/custom/ and _scss/custom/ with native Jekyll SCSS pipeline
  • 8a14089 Support custom permalink frontmatter overrides in pagers and document property schema
  • abc0152 Add support for published: true/false frontmatter and document property schema
  • 26ee36c Standardize frontmatter schema: clear title/summary/parent/grand_parent/nav_order and convert 404 to Markdown
  • cc91ca3 Replace site.scss frontmatter with precompiled standard site.css to fix GitHub Pages build
  • 7ed9d5c Configure catalogue and store as collections supporting subfolders and dedicated item pages
  • daf652e Use explicit placeholder items in catalogue and store preview pages
  • 67a9053 Remove mock themes and packages from templates; make toolbars conditional
  • e57da5a Add catalogue, store, changelog, and faq layouts with modular SCSS and preview pages
  • 4f47c91 Refactor docs layout: remove left sidebar in favor of in-page Table of Contents
  • dbe7af1 Migrate styling to modular SCSS architecture with compressed compilation
  • 1dc754b Fix markdown rendering, add collections, and configure navigation
  • 1c91557 Initial commit: helix-docs GitHub Pages Jekyll theme

Full commit history: git log --oneline 1c91557..90c608b