Installation

pnpm i vitepress vitepress-theme-snow

Quick Start

It is recommended that you have prior knowledge of VitePress.

1. run a command to init vitepress

pnpm vitepress init

2. select the Custom Theme when you see the follow questions:

┌  Welcome to VitePress!
│
◇  Where should VitePress initialize the config?
│  ./docs
│
◇  Site title:
│  My Awesome Project
│
◇  Site description:
│  A VitePress Site
│
◆  Theme:
│  ○ Default Theme (Out of the box, good-looking docs)
│  ○ Default Theme + Customization
│  ● Custom Theme
└

3. create a index.ts under the .vitepress/theme

import type { Theme } from 'vitepress'
import YevTheme from 'vitepress-theme-snow'
import 'vitepress-theme-snow/styles/index.css'
export default {
  ...YevTheme
} satisfies Theme

4. Learn more in ~~documentation~~

Short-term Goal

• Home Lauout
  • [ ] TimeLine Section
  • [ ] Quick-link
  • [ ] i18n
• Basic Markdown Layout
  • [x] Last update time
  • [ ] Previous and next pagination
  • [x] Slidebar outline
    • [ ] For Mobile
    • [ ] Change the Browser Title
  • [ ] Page context footer
• ...

Screen Capture

Thanks

Most of the code comes from Shiro

Lisense

© 2024 Yev Wang

Licensed under the AGPLv3 license.

In addition to the terms of the AGPLv3, the following additional conditions apply:

ADDITION_TERMS.