VitePressStarter

vitepress-starter — VitePress Starter Template

By Vincent-the-gamer

A starter template for VitePress documentation sites, preconfigured with multilingual support, navigation, and sidebar settings, and integrating UnoCSS, the Teek theme, twoslash, and ESLint.

Open Source Site Download Source ZIP

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

2 previews

Desktop homepage1 / 2

Visit websiteOpens in a new tab

Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 2

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-15View source

What stands out

A quick read of the recorded project description.

Preconfigured home page, navigation bar, and sidebar; ready out of the box as a documentation site structure

Supports i18n multilingual content

Theme switching uses View Transitions API animations

Code blocks integrate twoslash, which can display TypeScript compiler hints

Integrates UnoCSS and the VitePress Theme Teek theme

Uses ESLint to lint and format code and Markdown, and taze to update dependencies

Template Details

This is a starter template for a VitePress documentation site; the README describes it as an opinionated template. The repository comes preconfigured with a home page, navigation bar, and sidebar, and supports i18n multilingual content. Theme switching uses the View Transitions API for animation effects; code blocks support twoslash, which can display TypeScript compiler hints within code. For styling, it integrates UnoCSS and uses VitePress Theme Teek to enhance the documentation's appearance. Code and Markdown linting and formatting are handled by ESLint, and dependency updates use taze.

For usage, the README provides two paths: create a repository from the template on GitHub, or clone it locally with degit (without the .git directory). Installing dependencies, development, building, formatting, and dependency updates correspond to pnpm i, pnpm run dev, pnpm run build, pnpm run lint:fix, and pnpm run dep, respectively. The README specifically notes: the base url must be modified in contents/.vitepress/hooks/useBaseUrl.ts; the carbon theme is on the carbon branch. The README does not specify Node version requirements, deployment process details, or the specific configuration method for each feature.

VitePressStarter

Is it right for your project?

Use Cases

Building a technical documentation site for an individual or project
Sites that need multilingual documentation
Documentation where code examples should include TypeScript type hints
Quickly starting with VitePress as a base and customizing the theme

Suitable For

Developers writing documentation with VitePress
Teams that need multilingual documentation sites
Projects that prefer a pnpm and ESLint workflow

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

1
You can create a repository from the GitHub template, or clone it locally using npx/pnpx degit (without the .git directory)
2
Install dependencies: pnpm i
3
Local development: pnpm run dev; build: pnpm run build
4
Format code: pnpm run lint:fix; update dependencies: pnpm run dep
5
The base url must be modified in contents/.vitepress/hooks/useBaseUrl.ts; the carbon theme is on the carbon branch

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is the code of this version and does not mean that external services or third-party assets are free.

Must comply with when using

Free use, modification, commercial use, and distribution of this version's code are permitted.
When distributing copies or substantial portions of the code, retain the original author's copyright notice and the complete MIT license notice.
The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses; they cannot be judged solely by the code's MIT license.
External services such as domains, hosting, databases, payments, or AI may incur additional charges.

View Original Text Basis

Permission is hereby granted, free of charge
Original License Text

https://github.com/Vincent-the-gamer/vitepress-starter/blob/main/LICENSE https://github.com/Vincent-the-gamer/vitepress-starter/blob/main/README.md

Compiled by DeepSeek based on repository license and README ·2026-10-15. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms: GitHub
Documentation and maintenance reference score: More documented · 83 / 100
Technologies: VitePress
Website type: Starter

How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded: 2026-05-05
Screenshot last checked: 2026-10-15

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies VitePress as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Review declaration: codex-user-requested-batch-review-20261015 · 2026-10-15

Inspect the recorded source material

SHA-256: 64b5cf5569f4cd951e3bdf96991f9e35a63eb8e641b9eb547a93d255229cde36

2026-10-15T00:13:04.858Z

Source file / repository

<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)

Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.

vitepress-blog-starter

A VitePress-based blog starter template with runnable example content for posts and authors, blog logic organized through Composables, UnoCSS styling, and VitePress's built-in local search. It uses pnpm for installation, development, and build, and the repository is MIT licensed.

VitePress · Blog

carbon-starter

A VitePress documentation site starter template paired with the VitePress Carbon theme and Carbon Design System styling. It provides docs:dev, docs:build, and docs:preview scripts, is created via GitHub's Use this template, and is released under the MIT license.

VitePress · Documentation

vitepress-diataxis-template

A VitePress-based technical documentation template that organizes tutorials, how-to guides, reference, and explanation content using the Diátaxis framework.

Vue · Documentation

vitepress-vue-starter-template

A documentation site starter template combining VitePress, Vue.js, and Tailwind CSS. The README only documents cloning the repository, installing dependencies with bun, yarn, or pnpm, and running npm run docs:dev, npm run docs:build, and npm run docs:serve.

Vue · Starter

vitepress-template

A VitePress template and starter project based on Vue3 and VitePress. The repository includes a landing-page package positioned as a product website and corporate website, with a demo preview link and desktop and mobile preview screenshots.

Vue · Corporate Website

ant-design-pro

Ant Design Pro is an enterprise-grade React admin scaffold built on React 19, Umi Max 4, and antd 6 with TypeScript.

React · Admin dashboard