# 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.

Jekyll VitePress Theme provides a VitePress-like documentation experience with Jekyll-native navigation, search, Markdown extensions, project integrations, SEO, and AI-readable discovery files. The canonical documentation is [jekyll-vitepress.dev](https://jekyll-vitepress.dev), the source is on [GitHub](https://github.com/crmne/jekyll-vitepress-theme), and releases are published on [RubyGems](https://rubygems.org/gems/jekyll-vitepress-theme).

## Full Documentation

- [Complete documentation](https://jekyll-vitepress.dev/llms-full.txt): All canonical pages in one Markdown document.

## Overview

- [Jekyll VitePress Theme](https://jekyll-vitepress.dev/): VitePress-style documentation theme and plugin for Jekyll sites, with Jekyll-first extensions beyond VitePress.

## Introduction

- [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.

## Core Features

- [Navigation and Layout](https://jekyll-vitepress.dev/navigation-layout/): How header, sidebar, content, and outline areas are composed.
- [Nested Sidebar Items](https://jekyll-vitepress.dev/nested-sidebar-items/): Use Jekyll frontmatter to build VitePress-style nested sidebar trees inside each collection.
- [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 callouts, inline labels, and reusable project buttons.
- [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.

## Advanced

- [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.
- [SEO and Discovery](https://jekyll-vitepress.dev/seo-and-discovery/): Ship canonical metadata, social cards, structured data, sitemap, robots controls, and multilingual alternates with every docs site.

## Reference

- [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.