# @evgenest/vitepress-theme-contour 中文文档

规范地址：https://npmcn.com/package/%40evgenest/vitepress-theme-contour/

版本：1\.0\.1
npm 元数据更新时间：2026-10-31T23:26:25.836Z
中文译文更新时间：2026-11-01T03:03:59.598Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40evgenest/vitepress-theme-contour
原文对照：https://npmcn.com/package/%40evgenest/vitepress-theme-contour/?lang=original
项目主页：https://github.com/evgenest/vitepress-theme-contour#readme
源码仓库：https://github.com/evgenest/vitepress-theme-contour

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：31.8 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：vue ^3\.5\.0，vitepress ^2\.0\.0-alpha\.21
- 首次发布：2026-10-31T22:40:00.186Z
- 最新版本发布：2026-10-31T23:26:25.545Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

一个VitePress 2主题，具有更平静的布局，框架代码块，全局行换行开关和自动/亮/暗开关。

## 安装

```sh
npm install @evgenest/vitepress-theme-contour
```

也可以使用：`pnpm add @evgenest/vitepress-theme-contour`、`yarn add @evgenest/vitepress-theme-contour`、`bun add @evgenest/vitepress-theme-contour`

## README

# @evgenest / vitepress-theme-contour

一个主题 [VitePress](https://vitepress.dev/) 2 .增加了一些变化，以股票的外观：一个更宽的布局，框架代码块和一些小的工具，阅读长代码。它扩展了默认主题，所以你已经在VitePress中使用的一切都可以继续工作，包括本地搜索。

> **需要VitePress 2**，它仍然是。主题风格的一些VitePress的内部类名，所以一个新的VitePress版本可以打破它的一部分。保持您的锁文件提交，并在升级后查看您的站点。

## 功能

**布局**

-   左侧栏固定在窗口边缘，活动页面位于填充的背景上
-   搜索框和页面文本在一行上对齐
-   一个更宽的文本列，最大1100px
-   “在此页上”的轮廓环绕在右边缘，只占用文本所需的宽度
-   在窄屏幕上滚动时保持可见的站点标题

**代码块**

-   框架，高对比度纯文本和样式但可见的滚动条
-   鼠标悬停时出现的复制按钮，并显示绿色的“复制！”标签
-   换行按钮：一次点击适用于网站上的每个代码块，并在浏览器中被记住
-   文本永远不会在按钮下面运行：换行文本在按钮周围流动，未换行的第一行在按钮前面逐渐消失，然后滚动完全清除

**导航**

-   宽屏幕上的自动/亮/暗开关
-   上一个和下一个链接与箭头卡
-   在窄屏幕上，大纲突出显示当前部分，并在您选择项目后关闭
-   `sidebarTree()` 从文件夹构建嵌套的侧边栏
-   界面语言：英语或俄语

## 安装

```sh
bun add -d vitepress@next @evgenest/vitepress-theme-contour
```

Npm， PNPM和yarn也可以工作。

## 设置

`.vitepress/theme/index.ts`：

```ts
export { default } from '@evgenest/vitepress-theme-contour'
```

`.vitepress/config.ts`：

```ts
import { contourConfig, sidebarTree } from '@evgenest/vitepress-theme-contour/config'

export default {
  extends: contourConfig({ locale: 'en' }), // or 'ru'
  title: 'My docs',
  themeConfig: {
    sidebar: sidebarTree(),
  },
}
```

## 侧边栏

`sidebarTree()` 将每个文件夹转换为嵌套组，并将每个Markdown文件转换为链接。所有选项都是可选的：

```ts
sidebarTree({
  srcDir: 'docs',                    // same as srcDir in your config
  exclude: ['drafts.md'],            // paths relative to srcDir
  order: ['intro.md', 'guide'],      // listed first, the rest follow alphabetically
  titles: { 'intro.md': 'Welcome' }, // overrides the name in the menu
  rootLabel: 'Docs',                 // wraps the tree in one top-level group
  collapsed: false,
})
```

菜单名的由来 `titles`，然后是正面物质 `title`，然后是第一个 `#` 标题，然后是文件名。

`exclude` 只隐藏菜单中的一页。要将其从站点中删除，还可以将其添加到 `srcExclude`.

一、 `README.md` 在…的根源 `srcDir` 链接 `/`，所以添加 `rewrites: { 'README.md': 'index.md' }` 如果你用一个作为你的主页。

## 你自己的 `markdown.config`

你可以设置 `markdown.config` 像往常一样：VitePress将其与主题本身一起运行，因此wrap按钮保留。

## 颜色

颜色是CSS变量。在您自己的样式表中覆盖它们，从 `.vitepress/theme/index.ts`：

```css
:root { --vp-c-brand-1: #0f766e; }
.dark { --vp-c-brand-1: #5eead4; }
```

## 许可证

麻省理工学院

## 常见问题

### @evgenest/vitepress-theme-contour 是什么？

一个VitePress 2主题，具有更平静的布局，框架代码块，全局行换行开关和自动/亮/暗开关。

### 如何安装 @evgenest/vitepress-theme-contour？

在项目目录运行 npm install @evgenest/vitepress-theme-contour，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.5\.0）、vitepress（^2\.0\.0-alpha\.21）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @evgenest/vitepress-theme-contour 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @evgenest/vitepress-theme-contour 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @evgenest/vitepress-theme-contour 可以商用吗？

@evgenest/vitepress-theme-contour 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @evgenest/vitepress-theme-contour 还在维护吗？

最新版本 1\.0\.1 发布于 2026/11/01（2 天前）；至今共发布 3 个版本，其中过去 12 个月发布了 3 个；首次发布于 2026/11/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。