配置

配置文件

如果没有任何配置，你的 VuePress 站点仅有一些最基础的功能。为了更好地自定义你的网站，让我们首先在你的文档目录下创建一个 .vuepress 目录，所有 VuePress 相关的文件都将会被放在这里。你的项目结构可能是这样：

  1. ├─ docs
  2. │  ├─ .vuepress
  3. │  │  └─ config.js
  4. │  └─ README.md
  5. ├─ .gitignore
  6. └─ package.json

VuePress 站点必要的配置文件是 .vuepress/config.js，它应该导出一个 JavaScript 对象。如果你使用 TypeScript ，你可以将其替换为 .vuepress/config.ts ，以便让 VuePress 配置得到更好的类型提示。

  • JS
  • TS
  1. module.exports = {
  2.   lang: 'zh-CN',
  3.   title: '你好， VuePress ！',
  4.   description: '这是我的第一个 VuePress 站点',
  6.   themeConfig: {
  7.     logo: 'https://vuejs.org/images/logo.png',
  8.   },
  9. }
  1. import { defineUserConfig } from 'vuepress'
  2. import type { DefaultThemeOptions } from 'vuepress'
  4. export default defineUserConfig<DefaultThemeOptions>({
  5.   lang: 'en-US',
  6.   title: 'Hello VuePress',
  7.   description: 'Just playing around',
  9.   themeConfig: {
  10.     logo: 'https://vuejs.org/images/logo.png',
  11.   },
  12. })

提示

我们接下来会把这个配置对象称为 VuePress 配置.

配置作用域

你可能已经注意到了，在 VuePress 配置中有一项 themeConfig 配置项。

在 themeConfig 外部的配置项属于 站点配置 ，而在 themeConfig 内部的配置项则属于 主题配置。

站点配置

站点配置的意思是，无论你使用什么主题，这些配置项都可以生效。

我们知道，每一个站点都应该有它的 lang, title 和 description 等属性，因此 VuePress 内置支持了这些属性的配置。

提示

前往 配置参考 查看所有站点配置。

主题配置

主题配置将会被 VuePress 主题来处理，所以它取决于你使用的主题是什么。

如果你没有设置 VuePress 配置的 theme 配置项，则代表使用的是默认主题。

提示

前往 默认主题 > 配置参考 查看默认主题的配置。