mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
24 lines
754 B
24 lines
754 B
3 years ago
|
# Configuration
|
||
|
|
|
||
|
|
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 `.vitepress` directory inside your docs directory. This is where all VitePress-specific files will be placed. Your project structure is probably like this:
|
||
|
|
|
||
|
|
```
|
||
|
|
.
|
||
|
|
├─ docs
|
||
|
|
│ ├─ .vitepress
|
||
|
|
│ │ └─ config.js
|
||
|
|
│ └─ index.md
|
||
|
|
└─ package.json
|
||
|
|
```
|
||
|
|
|
||
|
|
The essential file for configuring a VitePress site is `.vitepress/config.js`, which should export a JavaScript object:
|
||
|
|
|
||
|
|
```js
|
||
|
|
export default {
|
||
|
|
title: 'Hello VitePress',
|
||
|
|
description: 'Just playing around.'
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Learn everything about VitePress configuration at [configuration page](../config/introduction).
|