Skip to content

Add Jekyll VitePress Theme #564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
crmne wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Jekyll VitePress Theme #564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions content/theme/jekyll-vitepress-theme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Jekyll VitePress Theme
github: https://github.com/crmne/jekyll-vitepress-theme
demo: https://jekyll-vitepress.dev
author: Carmine Paolino
date: 2026-03-23
ssg:
- Jekyll
cms:
- No CMS
css:
- CSS
archetype:
- Documentation
description: A VitePress-style documentation theme for Jekyll, packaged as a reusable theme + plugin gem.
---

# Jekyll VitePress Theme

Jekyll VitePress Theme reproduces the VitePress documentation experience in a pure Jekyll workflow.

## Features

- VitePress-style top nav, sidebar, and right-side outline
- Built-in local search modal (`/`, `Ctrl/Cmd+K`, `Cmd+K`)
- Dark, light, and auto appearance modes
- Code copy buttons, language labels, and file-title bars
- Optional GitHub star button with live count
- Jekyll-native extension hooks and YAML-based configuration
- Works as a gem-based theme for Jekyll sites