https://github.com/yunyoujun/vitepress-theme-you

🎮 A theme for vitepress. Sister of hexo-theme-yun.
https://github.com/yunyoujun/vitepress-theme-you

docs theme vitepress

Last synced: 17 days ago
JSON representation

🎮 A theme for vitepress. Sister of hexo-theme-yun.

• Host: GitHub
• URL: https://github.com/yunyoujun/vitepress-theme-you
• Owner: YunYouJun
• License: mit
• Created: 2021-07-31T09:30:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-22T17:24:18.000Z (6 months ago)
• Last Synced: 2024-12-10T11:05:01.732Z (24 days ago)
• Topics: docs, theme, vitepress
• Language: Vue
• Homepage: https://you.yunyoujun.cn
• Size: 330 KB
• Stars: 18
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# vitepress-theme-you

> 🎮 你的下一个文档主题（开发中）

> Can not work well yet, do not use it.

[![npm](https://img.shields.io/npm/v/vitepress-theme-you)](https://npmjs.com/package/vitepress-theme-you)

- Preview: [you.yunyoujun.cn](https://you.yunyoujun.cn)

## Usage

```bash

pnpm i vitepress

```

More info see [vitepress](https://github.com/vuejs/vitepress). Base on [theme-default | vitepress](https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/).

Config `.vitepress/config.ts`:

```ts

import baseConfig from 'vitepress-theme-you/config'

export default {

  extends: baseConfig,

  // ...

}

```

Config `.vitepress/theme/index.ts`:

```ts

import type { Theme } from 'vitepress'

import { VPTheme } from 'vitepress-theme-you'

import 'uno.css'

const theme: Theme = Object.assign({}, VPTheme, {

  enhanceApp: ({ app }) => {

    // ...

  },

})

export default theme

```

## Who use it?

- [advjs](https://github.com/YunYouJun/advjs/)

- [augma](https://github.com/YunYouJun/augma/)

- [el-bot](https://github.com/YunYouJun/el-bot)

- [vtuber](https://github.com/YunYouJun/vtuber)

- [hexo-theme-yun](https://github.com/YunYouJun/hexo-theme-yun)

## [Sponsors](https://sponsors.yunyoujun.cn)