primer2

A two-column GitBook-style Jekyll theme for GitHub Pages, built on GitHub’s Primer design system.

View on GitHub Use the template

Features

  • Two-column layout — fixed sidebar with auto-generated page navigation on the left, main content on the right
  • Sidebar search — client-side full-text search powered by Lunr.js, no server required
  • Responsive — collapses to a single column on mobile with a hamburger menu and overlay backdrop
  • Auto navigation — all pages with layout: default appear in the sidebar automatically, ordered by optional order front matter
  • Syntax highlighting — via Rouge
  • Math (MathJax) — render LaTeX equations inline or as display blocks with mathjax: true front matter
  • Diagrams (Mermaid) — render flowcharts, sequence diagrams, and more with mermaid: true front matter
  • SEO ready — uses jekyll-seo-tag for meta tags

Repository structure

Repository Purpose
primer2-theme Theme source — layouts, sass, includes
primer2-template Starter site — click “Use this template”
primer2 This documentation site