1.3 KiB
Configuration
Config File
Without any configuration, the page is pretty minimal, and the user has no way to navigate around the site. To customize your site, let's first create a .vuepress directory inside your docs directory. This is where all VuePress-specific files will be placed in.
The essential file for configuring a VuePress site is .vuepress/config.js, which should export a JavaScript object:
module.exports = {
title: 'Hello VuePress',
description: 'Just playing around'
}
If you've got the dev server running, you should see the page now has a header with the title and a search box. VuePress comes with built-in headers-based search - it automatically builds a simple search index from the title, h2 and h3 headers from all the pages.
Consult the Config Reference for a full list of options.
Theme Configuration
A VuePress theme is responsible for all the layout and interactivity details of your site. VuePress ships with a default theme (you are looking at it right now) which is designed for technical documentation. It exposes a number of options that allow you to customize the navbar, sidebar and homepage, etc. For details, check out the Default Theme Config page.
If you wish to develop a custom theme, see Custom Themes.