yuany3721/vuepress-theme-plume
1
0
Fork 0
forked from gitea-yuany3721/vuepress-theme-plume
Code Pull Requests Activity

docs: update readme

Browse Source
This commit is contained in:
pengzhanbo 2024-01-06 00:17:21 +08:00
parent 2f8607fc96
commit 1355bd580d
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
readme.md
View File

@ -2,11 +2,11 @@
一个简约的 vuepress 主题。
开箱即用，仅需少量配置即可使用。
开箱即用，仅需少量配置即可使用，让您更专注于 内容的创作。
[![npm version](https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=npm)](https://www.npmjs.com/package/vuepress-theme-plume)
[![npm beta download](https://img.shields.io/npm/dt/@vuepress-plume/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=beta%20downloads)](https://www.npmjs.com/package/vuepress-theme-plume)
[![npm download](https://img.shields.io/npm/dy/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/vuepress-theme-plume)
[![npm download](https://img.shields.io/npm/dm/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/vuepress-theme-plume)
![GitHub License](https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A)
### [查看文档](https://pengzhanbo.cn/note/vuepress-theme-plume)
@ -14,11 +14,11 @@
## Install
``` sh
npm install vuepress@next vuepress-theme-plume
npm install vue vuepress@next vuepress-theme-plume
# or
pnpm add vuepress@next vuepress-theme-plume
pnpm add vue vuepress@next vuepress-theme-plume
# or
yarn add vuepress@next vuepress-theme-plume
yarn add vue vuepress@next vuepress-theme-plume
```
## Usage
@ -28,8 +28,9 @@ import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
// vuepress config...
theme: plumeTheme({
// theme config
// theme config...
})
})
```