---
title: "Guides"
description: "Every guide in VitePress."
---

# Guides

Every guide in VitePress.

- [Customization](./guides/customization-index.md)
- [Experimental](./guides/experimental-index.md)
- [Guide](./guides/guide-index.md)
- [Introduction](./guides/introduction-index.md)
- [Overview](./guides/overview-index.md)
- [Reference](./guides/reference-index.md)
- [Writing](./guides/writing-index.md)
- [Frontmatter Config](./guides/reference-frontmatter-config.md) — Reference of all available frontmatter configuration options for VitePress Markdown pages.
- [MPA Mode](./guides/experimental-mpa-mode.md) — Enable MPA (Multi-Page Application) mode in VitePress for zero-JavaScript pages with better initial performance.
- [Markdown Extensions](./guides/writing-markdown.md) — VitePress built-in Markdown extensions including custom containers, code blocks with syntax highlighting, line highlighting, code groups, and more.
- [Site Config](./guides/guide-site-config.md) — Complete reference of VitePress site configuration options including app-level settings, theming, and build options.
- [Using a Custom Theme](./guides/customization-custom-theme.md) — Create and use a custom theme in VitePress to fully control the look and feel of your site.
- [VitePress](./guides/overview-overview.md) — VitePress is a Vite & Vue powered static site generator that lets you create beautiful documentation sites from Markdown.
- [What is VitePress?](./guides/introduction-what-is-vitepress.md) — VitePress is a static site generator designed for building fast, content-centric websites powered by Vite and Vue.
- [Asset Handling](./guides/writing-asset-handling.md) — Learn how to reference and handle static assets such as images, media, and fonts in VitePress.
- [Extending the Default Theme](./guides/customization-extending-default-theme.md) — Customize and extend the VitePress default theme with custom CSS, components, layouts, and slots.
- [Getting Started](./guides/introduction-getting-started.md) — Get up and running with VitePress. Learn how to install, scaffold, and start developing your documentation site.
- [Runtime API](./guides/reference-runtime-api.md) — Reference of VitePress runtime APIs including composables, helper functions, and built-in components.
- [Sitemap Generation](./guides/experimental-sitemap-generation.md) — Generate a sitemap.xml file for your VitePress site to improve search engine discoverability.
- [Build-Time Data Loading](./guides/customization-data-loading.md) — Load arbitrary data at build time using VitePress data loaders and import it from pages or components.
- [Command Line Interface](./guides/reference-cli.md) — Reference of VitePress CLI commands including dev, build, preview, and init.
- [Frontmatter](./guides/writing-frontmatter.md) — Learn how to use YAML frontmatter in VitePress Markdown files to control page-level metadata and behavior.
- [Routing](./guides/introduction-routing.md) — Understand VitePress file-based routing, dynamic routes, clean URLs, and path rewrites.
- [Default Theme](./guides/reference-default-theme.md)
  - [Default Theme Config](./guides/reference-default-theme-config.md) — Reference of all configuration options available for the VitePress default theme.
  - [Nav](./guides/reference-default-theme-nav.md) — Configure the navigation bar in the VitePress default theme including site title, logo, and menu links.
  - [Sidebar](./guides/reference-default-theme-sidebar.md) — Configure the sidebar navigation in the VitePress default theme with groups, collapsible sections, and multiple sidebars.
  - [Home Page](./guides/reference-default-theme-home-page.md) — Configure the VitePress default theme home page layout with hero sections, features, and custom content.
  - [Footer](./guides/reference-default-theme-footer.md) — Configure the global footer displayed at the bottom of VitePress pages.
  - [Layout](./guides/reference-default-theme-layout.md) — Choose between doc, page, and home layouts in the VitePress default theme.
  - [Badge](./guides/reference-default-theme-badge.md) — Use the Badge component to add status labels to headers in VitePress documentation.
  - [Team Page](./guides/reference-default-theme-team-page.md) — Create team pages with member profiles using VitePress built-in team components.
  - [Prev Next Links](./guides/reference-default-theme-prev-next-links.md) — Customize the previous and next page links displayed at the bottom of doc pages in VitePress.
  - [Edit Link](./guides/reference-default-theme-edit-link.md) — Display an edit link on doc pages to let users suggest changes on GitHub or GitLab.
  - [Last Updated](./guides/reference-default-theme-last-updated.md) — Show the last updated timestamp on VitePress pages based on Git commit history.
  - [Search](./guides/reference-default-theme-search.md) — Set up local or Algolia-powered search for your VitePress site.
  - [Carbon Ads](./guides/reference-default-theme-carbon-ads.md) — Integrate Carbon Ads into your VitePress site using the default theme's built-in support.
- [Deploy Your VitePress Site](./guides/introduction-deploy.md) — Deploy your VitePress site to popular platforms like Netlify, Vercel, GitHub Pages, and more.
- [SSR Compatibility](./guides/customization-ssr-compat.md) — Ensure your VitePress theme components and custom code are compatible with server-side rendering.
- [Using Vue in Markdown](./guides/writing-using-vue.md) — Use Vue components and dynamic templating features directly inside Markdown files in VitePress.
- [Connecting to a CMS](./guides/customization-cms.md) — Connect VitePress to a headless CMS using dynamic routes and data loaders.
- [Internationalization](./guides/writing-i18n.md) — Set up internationalization (i18n) in VitePress to support multiple languages for your site.
- [Migration from VitePress 0.x](./guides/introduction-migration-from-vitepress-0.md)
- [Migration from VuePress](./guides/introduction-migration-from-vuepress.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.