gitea-yuany3721/vuepress-theme-plume
1
0
Fork 1
mirror of https://github.com/pengzhanbo/vuepress-theme-plume.git synced 2026-04-23 10:58:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(theme): add theme doc

Browse Source
This commit is contained in:
pengzhanbo 2023-02-15 00:54:24 +08:00
parent 3fdff1e96b
commit 98923f50e5
2 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/theme/README.md
View File

@ -17,10 +17,10 @@ npm i @vuepress-plume/vuepress-theme-plume
``` js
// .vuepress/config.ts
import { defineUserConfig } from 'vuepress'
import { themePlume } from '@vuepress-plume/vuepress-theme-plume'
import { plumeTheme } from '@vuepress-plume/vuepress-theme-plume'
export default defineUserConfig({
theme: themePlume({
theme: plumeTheme({
// theme config
})
})

8
readme.md
View File

@ -19,15 +19,15 @@ yarn add vuepress@next @vuepress-plume/vuepress-theme-plume
``` ts
import { defineUserConfig } from 'vuepress'
import { themePlume } from '@vuepress-plume/vuepress-theme-plume'
import { plumeTheme } from '@vuepress-plume/vuepress-theme-plume'
export default defineUserConfig({
theme: themePlume({
theme: plumeTheme({
// theme config
})
})
```
### `themePlume(options)`
### `plumeTheme(options)`
__options__ : `PlumeThemeOptions`
@ -60,5 +60,3 @@ __options__ : `PlumeThemeOptions`
本主题基于 `VuePress2` ，仍处于 Beta 阶段。
这意味着功能尚未完善，在未来有概率发生破坏性更改。
本主题已完成主要功能的开发，并用于个人博客，也欢迎各位使用，如能给小弟提供您宝贵的建议和意见，不胜感激。