1.0.2-beta.1 • Published 1 year ago
vitepress-theme-snow v1.0.2-beta.1
Installation
pnpm i vitepress vitepress-theme-snow
Quick Start
It is recommended that you have prior knowledge of VitePress.
- run a command to init vitepress
pnpm vitepress init
- 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
└
- 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
- Learn more in
documentation
Short-term Goal
- Home Lauout
- TimeLine Section
- Quick-link
- i18n
- Basic Markdown Layout
- Last update time
- Previous and next pagination
- 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:
1.0.2-beta.1
1 year ago