VitePress Starter

♥️ Opinionated Vitepress Template ♥️

Note

To configure base url, modify contents/.vitepress/hooks/useBaseUrl.ts.

Features

• i18n - multi-language support.
• Animation on theme changing - 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.
• medium-zoom - images zoom on click.
• UnoCSS - Instant On-demand Atomic CSS Engine

Usage

Use this template

1. Create repo from GitHub template.

2. Clone to local without .git folder.

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!

pnpm i

Dev

pnpm run serve

Format Code(use eslint)

pnpm run lint:fix

Build

pnpm run build

Update deps

pnpm run dep

Demo

Demo on Netlify