VitePress启动器

vitepress-starter — VitePress 启动器模板

作者 Vincent-the-gamer

基于 VitePress 的文档站点起步模板，预置多语言、导航与侧边栏配置，并集成 UnoCSS、Teek 主题、twoslash 与 ESLint。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

2 个预览视图
桌面端首页1 / 2
桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-15查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

01

预置主页面、导航栏与侧边栏，开箱即为文档站点结构

02

支持 i18n 多语言

03

主题切换使用 View Transitions API 动画

04

代码块集成 twoslash，可显示 TypeScript 编译器提示

05

集成 UnoCSS 与 VitePress Theme Teek 主题

06

使用 ESLint 检查并格式化代码与 Markdown，taze 更新依赖

模板详细介绍

这是一个 VitePress 文档站点的起步模板，README 将其描述为 opinionated（有既定取向的）模板。仓库已预置主页面、导航栏和侧边栏配置，并支持 i18n 多语言。主题切换时使用 View Transitions API 实现动画效果；代码块支持 twoslash，可在代码中显示 TypeScript 编译器提示。样式方面集成 UnoCSS，并采用 VitePress Theme Teek 美化文档外观。代码与 Markdown 的检查、格式化由 ESLint 负责，依赖更新使用 taze。

使用方式上，README 提供两条路径：在 GitHub 上以模板创建仓库，或用 degit 克隆到本地（不包含 .git 目录）。安装依赖、开发、构建、格式化与依赖更新分别对应 pnpm i、pnpm run dev、pnpm run build、pnpm run lint:fix 和 pnpm run dep。README 特别提示：base url 需在 contents/.vitepress/hooks/useBaseUrl.ts 中修改；carbon 主题位于 carbon 分支。README 未说明 Node 版本要求、部署流程细节或各功能的具体配置方式。

VitePress启动器

适合你的项目吗？

适用场景

  • 搭建个人或项目的技术文档站点
  • 需要多语言文档的站点
  • 希望代码示例带 TypeScript 类型提示的文档
  • 以 VitePress 为基础快速起步并自定义主题

适合人群

  • 使用 VitePress 编写文档的开发者
  • 需要多语言文档站点的团队
  • 偏好 pnpm 与 ESLint 工作流的项目

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

  1. 1

    可通过 GitHub 模板创建仓库，或使用 npx/pnpx degit 克隆到本地（不含 .git 目录）

  2. 2

    安装依赖：pnpm i

  3. 3

    本地开发：pnpm run dev；构建：pnpm run build

  4. 4

    格式化代码：pnpm run lint:fix；更新依赖：pnpm run dep

  5. 5

    base url 需修改 contents/.vitepress/hooks/useBaseUrl.ts；carbon 主题在 carbon 分支

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

  • 允许免费使用、修改、商用和分发该版本代码。
  • 分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
  • 代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

  • 演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
  • 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
查看原文依据

Permission is hereby granted, free of charge

许可证原文
https://github.com/Vincent-the-gamer/vitepress-starter/blob/main/LICENSEhttps://github.com/Vincent-the-gamer/vitepress-starter/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-15。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料较完整 · 83 / 100
技术栈
VitePress
网站类型
启动器
这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2026-05-05
截图检查日期
2026-10-15

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 VitePress。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

审核声明: codex-user-requested-batch-review-20261015 · 2026-10-15

查看当时使用的来源资料

SHA-256: 64b5cf5569f4cd951e3bdf96991f9e35a63eb8e641b9eb547a93d255229cde36

2026-10-15T00:13:04.858Z

来源文件 / 仓库
<p align="center">
    <img src="contents/public/logo/logo.png" style="height: 100px;"/>
</p>

<h1 align="center">VitePress Starter</h1>

<p align="center">
    <span>♥️ Opinionated Vitepress Template ♥️</span>
</p>

> [!NOTE]
> To configure base url, modify `contents/.vitepress/hooks/useBaseUrl.ts`.
>
> To see carbon theme, switch to branch [carbon](https://github.com/Vincent-the-gamer/vitepress-starter/tree/carbon)

# Features

- i18n - multi-language support.
- Animation on theme changing - [View Transitions API](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API).
- taze - 🥦 keep your dependencies fresh.🥦
- Pre-configured main page, navbars, sidebars.
- twoslash - Add a hint of TypeScript compiler in code.
- eslint - check and format codes and markdowns.
- [UnoCSS](https://unocss.dev/) - Instant On-demand Atomic CSS Engine
- [VitePress Theme Teek](https://github.com/Kele-Bingtang/vitepress-theme-teek) - beautify your doc.

# Usage

## Use this template

1. Create repo from GitHub template.

2. Clone to local without `.git` folder.

```shell
npx degit https://github.com/Vincent-the-gamer/vitepress-starter.git your-project-name

# pnpm
pnpx degit https://github.com/Vincent-the-gamer/vitepress-starter.git your-project-name
```

## Don't forget to install dependencies!

<pre align='center'>
pnpm i
</pre>

## Dev

<pre align='center'>
pnpm run dev
</pre>

## Format Code(use eslint)

<pre align='center'>
pnpm run lint:fix
</pre>

## Build

<pre align='center'>
pnpm run build
</pre>

## Update deps

<pre align='center'>
pnpm run dep
</pre>

# Demo

[Demo on Netlify](https://vp-starter.netlify.app)
反馈内容错误

看看同类模板

对比同技术栈与用途的模板，找到更适合的视觉与内容结构。

vitepress-blog-starter

vitepress-blog-starter

Vitepress Blog Starter Template

VitePress · 博客

carbon-starter

carbon-starter

A template for VitePress Carbon Theme

VitePress · 文档

vitepress-diataxis-template

vitepress-diataxis-template

The full-fledged tech doc template powered by VitePress & Diátaxis framework

Vue · 文档

vitepress-vue-starter-template

vitepress-vue-starter-template

Vitepress, Vue.js, Tailwind CSS Starter Kit(For Docs)

Vue · 启动器

vitepress-template

vitepress-template

vitepress template & starter

Vue · 企业官网

ant-design-pro

ant-design-pro

Ant Design Pro 是 Ant Design 官方推出的企业级中后台前端脚手架，基于 React 19、Umi Max 4 和 antd 6 构建，内置 TypeScript 支持。

React · 后台