Configuration

All theme options live under vp_theme in _config.yml.

vp_theme:
  logo: /assets/images/theme/vitepress-logo-mini.svg
  logo_light: /assets/images/theme/vitepress-logo-mini.svg
  logo_dark: /assets/images/theme/vitepress-logo-mini.svg
  site_title: Your Project

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

  version:
    current: v1.0.0
    items:
      - text: v1.0.0 (current)
        link: /
      - text: Changelog
        link: https://github.com/you/project/releases
        external: true

  social_links:
    - icon: github
      link: https://github.com/you/project
      aria_label: GitHub

  rouge_theme:
    light: github
    dark: github.dark

  google_fonts_url: "https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap"

  css_vars:
    light:
      # --vp-c-brand-1: "#3451b2"
    dark:
      # --vp-c-brand-1: "#a8b1ff"

For complete keys, see Configuration Reference.

Social icons support a curated built-in set (GitHub, X/Twitter, Discord, YouTube, etc.) and also custom SVG via icon.svg for anything else.

Need custom <head> tags (extra fonts, analytics, verification meta)? Create _includes/vp_slots/head.html in your site and add your tags there.

For multi-version docs in this theme repo, /_data/versions.yml drives the version selector (next, latest, and /v/x.y.z/ entries).