Introduction
What is VitePress?VitePress is a static site generator designed for building fast, content-centric websites powered by Vite and Vue.Getting StartedGet up and running with VitePress. Learn how to install, scaffold, and start developing your documentation site.RoutingUnderstand VitePress file-based routing, dynamic routes, clean URLs, and path rewrites.DeployDeploy your VitePress site to popular platforms like Netlify, Vercel, GitHub Pages, and more.
Writing
Markdown ExtensionsVitePress built-in Markdown extensions including custom containers, code blocks with syntax highlighting, line highlighting, code groups, and more.Asset HandlingLearn how to reference and handle static assets such as images, media, and fonts in VitePress.FrontmatterLearn how to use YAML frontmatter in VitePress Markdown files to control page-level metadata and behavior.Using Vue in MarkdownUse Vue components and dynamic templating features directly inside Markdown files in VitePress.InternationalizationSet up internationalization (i18n) in VitePress to support multiple languages for your site.
Customization
Using a Custom ThemeCreate and use a custom theme in VitePress to fully control the look and feel of your site.Extending the Default ThemeCustomize and extend the VitePress default theme with custom CSS, components, layouts, and slots.Build-Time Data LoadingLoad arbitrary data at build time using VitePress data loaders and import it from pages or components.SSR CompatibilityEnsure your VitePress theme components and custom code are compatible with server-side rendering.Connecting to a CMSConnect VitePress to a headless CMS using dynamic routes and data loaders.
Experimental
Guide
Reference
Frontmatter ConfigReference of all available frontmatter configuration options for VitePress Markdown pages.Runtime APIReference of VitePress runtime APIs including composables, helper functions, and built-in components.CLIReference of VitePress CLI commands including dev, build, preview, and init.
Default Theme
OverviewReference of all configuration options available for the VitePress default theme.NavConfigure the navigation bar in the VitePress default theme including site title, logo, and menu links.SidebarConfigure the sidebar navigation in the VitePress default theme with groups, collapsible sections, and multiple sidebars.Home PageConfigure the VitePress default theme home page layout with hero sections, features, and custom content.FooterConfigure the global footer displayed at the bottom of VitePress pages.LayoutChoose between doc, page, and home layouts in the VitePress default theme.BadgeUse the Badge component to add status labels to headers in VitePress documentation.Team PageCreate team pages with member profiles using VitePress built-in team components.Prev / Next LinksCustomize the previous and next page links displayed at the bottom of doc pages in VitePress.Edit LinkDisplay an edit link on doc pages to let users suggest changes on GitHub or GitLab.Last Updated TimestampShow the last updated timestamp on VitePress pages based on Git commit history.SearchSet up local or Algolia-powered search for your VitePress site.Carbon AdsIntegrate Carbon Ads into your VitePress site using the default theme's built-in support.