# Jekyll VitePress Theme

> Jekyll VitePress Theme is a VitePress-style documentation theme and plugin gem for Jekyll that also adds Jekyll-first extensions beyond VitePress.

## About

Jekyll VitePress Theme is a Jekyll theme and plugin gem that brings a VitePress-style documentation experience and Jekyll-first extensions to Ruby static sites.


## Key Topics

- Jekyll
- VitePress
- Ruby
- GitHub Pages
- Markdown
- Liquid
- Kramdown
- Rouge
- Turbo Frames
- Static Site Generation
- Documentation Themes
- Local Search
- Dark Mode

## Project

Jekyll VitePress Theme gives Jekyll sites a VitePress-like documentation experience while going beyond baseline VitePress with Jekyll-first extensions: top navigation, sidebars, page outlines, local search, dark mode, code blocks, callouts, labels, project buttons, edit links, doc footers, and Turbo-powered content navigation.

For the mirrored VitePress behavior, see https://jekyll-vitepress.dev/vitepress-parity/. For features added beyond baseline VitePress, see https://jekyll-vitepress.dev/extensions-to-vitepress/.

The canonical documentation is https://jekyll-vitepress.dev. The source code is published at https://github.com/crmne/jekyll-vitepress-theme, and the Ruby gem is published at https://rubygems.org/gems/jekyll-vitepress-theme.

## Documentation

- [What Is Jekyll VitePress Theme?](https://jekyll-vitepress.dev/what-is-jekyll-vitepress-theme/): What Jekyll is, and what this theme adds on top.
- [Getting Started](https://jekyll-vitepress.dev/getting-started/): Install and run Jekyll VitePress Theme in a few minutes.
- [Configuration](https://jekyll-vitepress.dev/configuration/): Configure branding, nav, sidebars, edit links, and theme tokens.
- [Overview](https://jekyll-vitepress.dev/overview/): How the theme is structured and where Turbo, Jekyll, and VitePress-style UI meet.
- [Navigation and Layout](https://jekyll-vitepress.dev/navigation-layout/): How header, sidebar, content, and outline areas are composed.
- [Search and Outline](https://jekyll-vitepress.dev/search-and-outline/): Keyboard search, generated index, and active heading tracking.
- [Markdown Extensions](https://jekyll-vitepress.dev/markdown-extensions/): Header anchors, external links, tables, and other automatic enhancements.
- [Code Blocks](https://jekyll-vitepress.dev/code-blocks/): Copy buttons, language labels, syntax palettes, and file-title icons.
- [Custom Blocks](https://jekyll-vitepress.dev/custom-blocks/): VitePress-style custom containers for tips, warnings, details, and other highlighted content.
- [Callouts, Labels, and Buttons](https://jekyll-vitepress.dev/callouts-labels-buttons/): Just the Docs-style callout syntax, inline labels, and reusable project buttons rendered with VitePress-style UI.
- [Customizing Styles](https://jekyll-vitepress.dev/customizing-styles/): Override tokens, fonts, and appearance behavior.
- [Extending Behavior](https://jekyll-vitepress.dev/extending-behavior/): Extend via layout/include overrides and custom scripts.
- [Deployment](https://jekyll-vitepress.dev/deployment/): Deploy a single docs site by default, with optional multi-version mode.
- [Configuration Reference](https://jekyll-vitepress.dev/configuration-reference/): Complete jekyll_vitepress and _data/* reference with practical examples.
- [Frontmatter Reference](https://jekyll-vitepress.dev/frontmatter-reference/): Page-level frontmatter options used by the theme.
- [VitePress Parity](https://jekyll-vitepress.dev/vitepress-parity/): What this theme mirrors from VitePress and where the Jekyll implementation intentionally differs.
- [Extensions to VitePress](https://jekyll-vitepress.dev/extensions-to-vitepress/): Optional Jekyll-first extensions to baseline VitePress behavior.
- [Troubleshooting](https://jekyll-vitepress.dev/troubleshooting/): Common setup and runtime issues.

## Links

- Website: https://jekyll-vitepress.dev
- GitHub: https://github.com/crmne/jekyll-vitepress-theme
- Rubygems: https://rubygems.org/gems/jekyll-vitepress-theme