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: 5 days 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 (10 months ago)
• Default Branch: main
• Last Pushed: 2024-11-08T01:57:16.000Z (7 days ago)
• Last Synced: 2024-11-08T02:40:56.768Z (7 days ago)
• Topics: template, vitepress, vitepress-template
• Language: CSS
• Homepage: https://vincent-the-gamer.github.io/vitepress-starter-demo/
• Size: 729 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 '/' or remove it in `.vitepress/config.ts` if you don't need.

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

# Usage

## Don't forget to install dependencies!

```shell

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