使用自定义主题

主题解析

您可以通过创建 .vitepress/theme/index.js 或 .vitepress/theme/index.ts 文件（“主题入口文件”）来启用自定义主题。

.
├─ docs                # project root
│  ├─ .vitepress
│  │  ├─ theme
│  │  │  └─ index.js   # theme entry
│  │  └─ config.js     # config file
│  └─ index.md
└─ package.json

当 VitePress 检测到主题入口文件的存在时，它将始终使用自定义主题而不是默认主题。但是，您可以扩展默认主题以在其基础上执行高级自定义。

主题接口

VitePress 自定义主题定义为具有以下接口的对象

interface Theme {
  /**
   * Root layout component for every page
   * @required
   */
  Layout: Component
  /**
   * Enhance Vue app instance
   * @optional
   */
  enhanceApp?: (ctx: EnhanceAppContext) => Awaitable<void>
  /**
   * Extend another theme, calling its `enhanceApp` before ours
   * @optional
   */
  extends?: Theme
}

interface EnhanceAppContext {
  app: App // Vue app instance
  router: Router // VitePress router instance
  siteData: Ref<SiteData> // Site-level metadata
}

主题入口文件应将主题作为其默认导出导出

// .vitepress/theme/index.js

// You can directly import Vue files in the theme entry
// VitePress is pre-configured with @vitejs/plugin-vue.
import Layout from './Layout.vue'

export default {
  Layout,
  enhanceApp({ app, router, siteData }) {
    // ...
  }
}

默认导出是自定义主题的唯一约定，并且仅 Layout 属性是必需的。因此，从技术上讲，VitePress 主题可以像单个 Vue 组件一样简单。

在您的布局组件中，它的工作方式与普通的 Vite + Vue 3 应用程序相同。请注意，主题也需要 SSR 兼容。

构建布局

最基本的布局组件需要包含一个 <Content /> 组件

vue

<!-- .vitepress/theme/Layout.vue -->
<template>
  <h1>Custom Layout!</h1>

  <!-- this is where markdown content will be rendered -->
  <Content />
</template>

上面的布局只是将每个页面的 Markdown 渲染为 HTML。我们可以添加的第一个改进是处理 404 错误

vue

<script setup>
import { useData } from 'vitepress'
const { page } = useData()
</script>

<template>
  <h1>Custom Layout!</h1>

  <div v-if="page.isNotFound">
    Custom 404 page!
  </div>
  <Content v-else />
</template>

该 useData() 帮助程序为我们提供了所有我们需要有条件地渲染不同布局的运行时数据。我们可以访问的另一个数据是当前页面的前置信息。我们可以利用它来允许最终用户控制每个页面的布局。例如，用户可以指示页面应使用具有以下内容的特殊主页布局

---
layout: home
---

我们可以调整我们的主题来处理这个问题

vue

<script setup>
import { useData } from 'vitepress'
const { page, frontmatter } = useData()
</script>

<template>
  <h1>Custom Layout!</h1>

  <div v-if="page.isNotFound">
    Custom 404 page!
  </div>
  <div v-if="frontmatter.layout === 'home'">
    Custom home page!
  </div>
  <Content v-else />
</template>

当然，您可以将布局拆分为更多组件

vue

<script setup>
import { useData } from 'vitepress'
import NotFound from './NotFound.vue'
import Home from './Home.vue'
import Page from './Page.vue'

const { page, frontmatter } = useData()
</script>

<template>
  <h1>Custom Layout!</h1>

  <NotFound v-if="page.isNotFound" />
  <Home v-if="frontmatter.layout === 'home'" />
  <Page v-else /> <!-- <Page /> renders <Content /> -->
</template>

查阅运行时 API 参考以了解主题组件中可用的所有内容。此外，您可以利用构建时数据加载来生成数据驱动的布局 - 例如，一个列出当前项目中所有博客文章的页面。

分发自定义主题

分发自定义主题的最简单方法是将其作为 GitHub 上的模板存储库提供。

如果您希望将主题作为 npm 包分发，请按照以下步骤操作

将主题对象作为默认导出导出到您的包条目中。
如果适用，将您的主题配置类型定义导出为 ThemeConfig。
如果您的主题需要调整 VitePress 配置，请将该配置导出到包子路径下（例如 my-theme/config），以便用户可以扩展它。
记录主题配置选项（通过配置文件和前置信息）。
提供有关如何使用您的主题的清晰说明（见下文）。