Setting the file. One moment.
Subchapter 12.4
references/core-config.mdMarkdown4 KBView on GitHub
VitePress configuration is defined in .vitepress/config.[js|ts|mjs|mts]. Use defineConfig for TypeScript intellisense.
// .vitepress/config.ts
import { defineConfig } from 'vitepress'
export default defineConfig({
// Site metadata
title: 'My Docs',
description: 'Documentation site',
lang: 'en-US',
// URL base path (for GitHub Pages: '/repo-name/')
base: '/',
// Theme configuration
themeConfig: {
// See theme-config.md
}
})export default defineConfig({
title: 'VitePress', // Displayed in nav, used in page titles
titleTemplate: ':title - Docs', // Page title format (:title = h1)
description: 'Site description', // Meta description
lang: 'en-US', // HTML lang attribute
head: [
['link', { rel: 'icon', href: '/favicon.ico' }],
['meta', { name: 'theme-color', content: '#5f67ee' }],
['script', { async: '', src: 'https://analytics.example.com/script.js' }]
]
})export default defineConfig({
// Source files directory (relative to project root)
srcDir: './src',
// Exclude patterns from source
srcExclude: ['**/README.md', '**/TODO.md'],
// Output directory
outDir: './.vitepress/dist',
// Cache directory
cacheDir: './.vitepress/cache',
// Clean URLs without .html extension (requires server support)
cleanUrls: true,
// Ignore dead links during build
ignoreDeadLinks: true,
// Or specific patterns:
ignoreDeadLinks: ['/playground', /^https?:\/\/localhost/],
// Get last updated timestamp from git
lastUpdated: true
})Map source paths to different output paths:
export default defineConfig({
rewrites: {
// Static mapping
'packages/pkg-a/src/index.md': 'pkg-a/index.md',
// Dynamic parameters
'packages/:pkg/src/:slug*': ':pkg/:slug*'
}
})export default defineConfig({
appearance: true, // Enable toggle (default)
appearance: 'dark', // Dark by default
appearance: 'force-dark', // Always dark, no toggle
appearance: 'force-auto', // Always follow system preference
appearance: false // Disable dark mode
})export default defineConfig({
// Pass options to Vite
vite: {
plugins: [],
resolve: { alias: {} },
css: { preprocessorOptions: {} }
},
// Pass options to @vitejs/plugin-vue
vue: {
template: { compilerOptions: {} }
},
// Configure markdown-it
markdown: {
lineNumbers: true,
toc: { level: [1, 2, 3] },
math: true, // Requires markdown-it-mathjax3
container: {
tipLabel: 'TIP',
warningLabel: 'WARNING',
dangerLabel: 'DANGER'
}
}
})export default defineConfig({
// Transform page data
transformPageData(pageData, { siteConfig }) {
pageData.frontmatter.head ??= []
pageData.frontmatter.head.push([
'meta', { name: 'og:title', content: pageData.title }
])
},
// Transform head before generating each page
async transformHead(context) {
return [['meta', { name: 'custom', content: context.page }]]
},
// After build completes
async buildEnd(siteConfig) {
// Generate sitemap, RSS, etc.
}
})For async configuration:
export default async () => {
const data = await fetch('https://api.example.com/data').then(r => r.json())
return defineConfig({
title: data.title,
themeConfig: {
sidebar: data.sidebar
}
})
}.js, .ts, .mjs, .mts extensionsdefineConfig for TypeScript supportbase must start and end with / for sub-path deploymentssrcDir separates source files from project root