Getting Started

Install the theme gem and enable it as both theme and plugin.

1. Add the gem

gem "jekyll-vitepress-theme"

Then install:

bundle install

2. Enable theme and plugin

theme: jekyll-vitepress-theme
plugins:
  - jekyll-vitepress-theme

3. Configure navigation

vp_theme:
  nav:
    - text: Guide
      link: /what-is-jekyll-vitepress-theme/
      collections: [getting_started, core_features, advanced]
    - text: Reference
      link: /configuration-reference/
      collections: [reference]

  sidebar_collections:
    - id: getting_started
      text: Introduction
    - id: core_features
      text: Core Features
    - id: advanced
      text: Advanced
    - id: reference
      text: Reference

4. Run locally

bundle exec jekyll serve --livereload

Open http://127.0.0.1:4000.

TIP

Set layout: home on your home page front matter to render the VitePress-style hero/features home without sidebar.