https://github.com/vincent-the-gamer/vitepress-starter

♥️ Opinionated VitePress Template ♥️
https://github.com/vincent-the-gamer/vitepress-starter

template vitepress vitepress-template

Last synced: about 1 month ago
JSON representation

♥️ Opinionated VitePress Template ♥️

• Host: GitHub
• URL: https://github.com/vincent-the-gamer/vitepress-starter
• Owner: Vincent-the-gamer
• License: mit
• Created: 2024-01-23T16:13:35.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-06T02:01:36.000Z (about 2 months ago)
• Last Synced: 2025-01-06T02:42:58.219Z (about 2 months ago)
• Topics: template, vitepress, vitepress-template
• Language: CSS
• Homepage: https://vincent-the-gamer.github.io/vitepress-starter-demo
• Size: 827 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



VitePress Starter




    ♥️ Opinionated Vitepress Template ♥️



> [!NOTE]

> Change the `base` option to '/' to remove base url prefix.

# 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.

- `medium-zoom` - images zoom on click.

# Usage

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

[https://vincent-the-gamer.github.io/vitepress-starter-demo/](https://vincent-the-gamer.github.io/vitepress-starter-demo/)