Extending the Default Theme
VitePress' default theme is optimized for documentation, and can be customized. Consult the Default Theme Config Overview for a comprehensive list of options.
However, there are a number of cases where configuration alone won't be enough. For example:
- You need to tweak the CSS styling;
- You need to modify the Vue app instance, for example to register global components;
- You need to inject custom content into the theme via layout slots.
These advanced customizations will require using a custom theme that "extends" the default theme.
Customizing CSS
Section titled “Customizing CSS”The default theme CSS is customizable by overriding root level CSS variables:
import DefaultTheme from 'vitepress/theme'
import './custom.css'
export default DefaultTheme/* .vitepress/theme/custom.css */
:root {
--vp-c-brand-1: #646cff;
--vp-c-brand-2: #747bff;
}See default theme CSS variables that can be overridden.
Navbar
Section titled “Navbar”The navbar draws a single background surface controlled by CSS variables, so its look can be changed without touching component internals:
:root {
/* bar height and background */
--vp-nav-height: 4rem;
--vp-nav-bg-color: var(--vp-c-bg);
/* background while on top of the home page (unscrolled);
set to var(--vp-nav-bg-color) to opt out of the transparent treatment */
--vp-nav-home-bg-color: transparent;
/* filter applied to the content behind the bar */
--vp-nav-backdrop-filter: none;
/* the bar's bottom rule and the mobile menu background */
--vp-nav-divider-color: var(--vp-c-gutter);
--vp-nav-screen-bg-color: var(--vp-c-bg);
}For example, a frosted-glass navbar:
:root {
--vp-nav-bg-color: color-mix(in srgb, var(--vp-c-bg) 65%, transparent);
--vp-nav-backdrop-filter: saturate(180%) blur(8px);
}The same treatment carries over to the local nav: --vp-local-nav-bg-color follows the navbar surface color by default, and where the two bars meet they share a single blurred surface, so the glass stays continuous across them.
When the nav items don't fit the available width, they move into the ⋯ menu at the end of the navbar instead of being clipped, starting with the social links, the appearance switch and the locale switcher, followed by the nav items right-to-left. Its button label can be localized with extraMenuLabel.
Using Different Fonts
Section titled “Using Different Fonts”VitePress uses Inter as the default font, and will include the fonts in the build output. The font is also auto preloaded in production. However, this may not be desirable if you want to use a different main font.
To avoid including Inter in the build output, import the theme from vitepress/theme-without-fonts instead:
import DefaultTheme from 'vitepress/theme-without-fonts'
import './my-fonts.css'
export default DefaultTheme/* .vitepress/theme/my-fonts.css */
:root {
--vp-font-family-base: /* normal text font */
--vp-font-family-mono: /* code font */
}If your font is a local file referenced via @font-face, it will be processed as an asset and included under .vitepress/dist/assets with hashed filename. To preload this file, use the transformHead build hook:
export default {
transformHead({ assets }) {
// adjust the regex accordingly to match your font
const myFontFile = assets.find(file => /font-name\.[\w-]+\.woff2/.test(file))
if (myFontFile) {
return [
[
'link',
{
rel: 'preload',
href: myFontFile,
as: 'font',
type: 'font/woff2',
crossorigin: ''
}
]
]
}
}
}Registering Global Components
Section titled “Registering Global Components”import DefaultTheme from 'vitepress/theme'
/** @type {import('vitepress').Theme} */
export default {
extends: DefaultTheme,
enhanceApp({ app }) {
// register your custom global components
app.component('MyGlobalComponent' /* ... */)
}
}If you're using TypeScript:
import type { Theme } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
export default {
extends: DefaultTheme,
enhanceApp({ app }) {
// register your custom global components
app.component('MyGlobalComponent' /* ... */)
}
} satisfies ThemeSince we are using Vite, you can also leverage Vite's glob import feature to auto register a directory of components.
Layout Slots
Section titled “Layout Slots”The default theme's <Layout/> component has a few slots that can be used to inject content at certain locations of the page. Here's an example of injecting a component into the before outline:
import DefaultTheme from 'vitepress/theme'
import MyLayout from './MyLayout.vue'
export default {
extends: DefaultTheme,
// override the Layout with a wrapper component that
// injects the slots
Layout: MyLayout
}<script setup>
import DefaultTheme from 'vitepress/theme'
const { Layout } = DefaultTheme
</script>
<template>
<Layout>
<template #aside-outline-before>
My custom sidebar top content
</template>
</Layout>
</template>Or you could use render function as well.
import { h } from 'vue'
import DefaultTheme from 'vitepress/theme'
import MyComponent from './MyComponent.vue'
export default {
extends: DefaultTheme,
Layout() {
return h(DefaultTheme.Layout, null, {
'aside-outline-before': () => h(MyComponent)
})
}
}Full list of slots available in the default theme layout:
- When
layout: 'doc'(default) is enabled via frontmatter:doc-topdoc-bottomdoc-footer-beforedoc-beforedoc-aftersidebar-nav-beforesidebar-nav-afteraside-topaside-bottomaside-outline-beforeaside-outline-afteraside-ads-beforeaside-ads-after
- When
layout: 'home'is enabled via frontmatter:home-hero-beforehome-hero-info-beforehome-hero-infohome-hero-info-afterhome-hero-actions-before-actionshome-hero-actions-afterhome-hero-imagehome-hero-afterhome-features-beforehome-features-after
- When
layout: 'page'is enabled via frontmatter:page-toppage-bottom
- On not found (404) page:
not-found
- Always:
layout-toplayout-bottomnav-bar-title-beforenav-bar-title-afternav-bar-content-beforenav-bar-content-afternav-screen-content-beforenav-screen-content-after
Using View Transitions API
Section titled “Using View Transitions API”On Appearance Toggle
Section titled “On Appearance Toggle”You can extend the default theme to provide a custom transition when the color mode is toggled. An example:
<script setup lang="ts">
import { useData } from 'vitepress'
import DefaultTheme from 'vitepress/theme'
import { nextTick, provide } from 'vue'
const { isDark } = useData()
const enableTransitions = () =>
'startViewTransition' in document &&
window.matchMedia('(prefers-reduced-motion: no-preference)').matches
provide('toggle-appearance', ({ clientX, clientY }: MouseEvent) => {
if (!enableTransitions()) {
isDark.value = !isDark.value
return
}
const x = (100 * clientX) / innerWidth
const y = (100 * clientY) / innerHeight
const maxRadius =
(100 *
Math.hypot(
Math.max(clientX, innerWidth - clientX),
Math.max(clientY, innerHeight - clientY)
)) /
(Math.hypot(innerWidth, innerHeight) / Math.SQRT2)
document.documentElement.style.setProperty('--switch-x', `${x}%`)
document.documentElement.style.setProperty('--switch-y', `${y}%`)
document.documentElement.style.setProperty('--switch-r', `${maxRadius}%`)
document.startViewTransition(async () => {
isDark.value = !isDark.value
await nextTick()
})
})
</script>
<template>
<DefaultTheme.Layout />
</template>
<style>
::view-transition-old(root),
::view-transition-new(root) {
animation: none;
mix-blend-mode: normal;
}
::view-transition-new(root) {
animation: switch-appearance 300ms ease-in;
}
.dark::view-transition-new(root) {
animation: none;
}
.dark::view-transition-old(root) {
animation: switch-appearance 300ms ease-in reverse forwards;
z-index: 1;
}
@keyframes switch-appearance {
from {
clip-path: circle(0 at var(--switch-x) var(--switch-y));
}
to {
clip-path: circle(var(--switch-r) at var(--switch-x) var(--switch-y));
}
}
.VPSwitchAppearance {
width: 1.375rem !important;
}
.VPSwitchAppearance .check {
transform: none !important;
}
</style>Result (warning!: flashing colors, sudden movements, bright lights):
Demo
Refer Chrome Docs from more details on view transitions.
On Route Change
Section titled “On Route Change”Coming soon.
Overriding Internal Components
Section titled “Overriding Internal Components”You can use Vite's aliases to replace default theme components with your custom ones:
import { fileURLToPath, URL } from 'node:url'
import { defineConfig } from 'vitepress'
export default defineConfig({
vite: {
resolve: {
alias: [
{
find: /^.*\/VPNavBar\.vue$/,
replacement: fileURLToPath(
new URL('./theme/components/CustomNavBar.vue', import.meta.url)
)
}
]
}
}
})To know the exact name of the component refer our source code. Since the components are internal, there is a slight chance their name is updated between minor releases.