Configuration

The essential file for configuring a VuePress site is .vuepress/config.js, which should export a JavaScript object:

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, and h3 headers from all the pages.

Alternative Config Formats

You can also use YAML () or TOML (.vuepress/config.toml) formats for the configuration file.

To develop a custom theme, see Writing a theme.

Since the VuePress app is a standard Vue app, you can apply app-level enhancements by creating a file , which will be imported into the app if it’s present. The file should export default a hook function which will receive an object containing some app-level values. You can use this hook to install extra Vue plugins, register global components, or add extra router hooks: