Configuration

Config File

VitePress configuration file is located at .vitepress/config.mts.

Site Config

Basic Config

export default defineConfig({
  title: "Site Title",
  description: "Site Description",
  lang: 'en-US',
})

Theme Config

Navigation Bar

themeConfig: {
  nav: [
    { text: 'Home', link: '/' },
    { text: 'Guide', link: '/guide/' }
  ]
}

Sidebar

themeConfig: {
  sidebar: [
    {
      text: 'Guide',
      items: [
        { text: 'Getting Started', link: '/guide/getting-started' }
      ]
    }
  ]
}

Social Links

themeConfig: {
  socialLinks: [
    { icon: 'github', link: 'https://github.com/' }
  ]
}

Page Config

Configure pages using frontmatter at the top of Markdown files:

---
layout: doc
title: Page Title
---

More Config

Visit VitePress Documentation for more configuration options.