mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
docs: update readme
This commit is contained in:
parent
f8ecdd907e
commit
ec67e529cb
@ -89,3 +89,9 @@ __options__
|
||||
## 查看详细说明文档
|
||||
|
||||
待补充
|
||||
|
||||
## 示例
|
||||
|
||||
### 插件开发示例
|
||||
|
||||
- [vuepress-plugin-page-collection](https://github.com/pengzhanbo/vuepress-theme-plume/tree/main/packages/plugin-page-collection) 基于 netlify-functions 的,通过在 functions中连接 `leancloud` 实现 博客文章页 阅读数/访问次数 的记录与展示。
|
||||
|
||||
48
readme.md
48
readme.md
@ -4,9 +4,57 @@
|
||||
|
||||
开箱即用,仅需少量配置即可使用。
|
||||
|
||||

|
||||

|
||||
|
||||
### [查看文档](https://pengzhanbo.cn/note/vuepress-theme-plume)
|
||||
|
||||
## Install
|
||||
|
||||
``` sh
|
||||
yarn add vuepress@next @vuepress-plume/vuepress-theme-plume
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
``` ts
|
||||
import { defineUserConfig } from 'vuepress'
|
||||
import { themePlume } from '@vuepress-plume/vuepress-theme-plume'
|
||||
export default defineUserConfig({
|
||||
theme: themePlume({
|
||||
// theme config
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
### `themePlume(options)`
|
||||
|
||||
__options__ : `PlumeThemeOptions`
|
||||
|
||||
[查看 options 详细说明](https://pengzhanbo.cn/note/vuepress-theme-plume/theme-config/)
|
||||
|
||||
## 案例
|
||||
|
||||
- [我的个人博客](https://pengzhanbo.cn/)
|
||||
|
||||
|
||||
## 内置插件
|
||||
|
||||
- [plugin-caniuse](https://github.com/pengzhanbo/vuepress-theme-plume/tree/main/packages/plugin-caniuse) 在文档中使用 caniuse 提供的 web feature support list
|
||||
- [vuepress-plugin-mdEnhance](https://vuepress-theme-hope.github.io/v2/md-enhance/zh/) 增强markdown功能插件
|
||||
- [vuepress-plugin-comment](https://vuepress-theme-hope.github.io/v2/comment/zh/) 文章评论插件,支持 "giscus" | "twikoo" | "waline"
|
||||
- [vuepress-plugin-copy-code](https://github.com/pengzhanbo/vuepress-theme-plume/tree/main/packages/plugin-copy-code) 文章内代码块复制插件
|
||||
- [vuepress-plugin-medium-zoom](https://v2.vuepress.vuejs.org/zh/reference/plugin/medium-zoom.html) 图片预览插件
|
||||
- [vuepress-plugin-prismjs](https://v2.vuepress.vuejs.org/zh/reference/plugin/prismjs.html) 代码块高亮插件
|
||||
- [vuepress-plugin-search](https://v2.vuepress.vuejs.org/zh/reference/plugin/search.html) 内容搜索插件
|
||||
- [vuepress-plugin-docsearch](https://v2.vuepress.vuejs.org/zh/reference/plugin/docsearch.html) Algolia docsearch 内容搜索插件
|
||||
- [vuepress-plugin-palette](https://v2.vuepress.vuejs.org/zh/reference/plugin/palette.html) 主题调色板插件
|
||||
- [vuepress-plugin-seo](https://vuepress-theme-hope.github.io/v2/seo/zh/) seo 插件
|
||||
- [vuepress-plugin-sitemap](https://vuepress-theme-hope.github.io/v2/sitemap/zh/) 生成sitemap 插件
|
||||
|
||||
## 非内置插件
|
||||
|
||||
- [vuepress-plugin-netlify-functions](https://github.com/pengzhanbo/vuepress-theme-plume/tree/main/packages/plugin-netlify-functions) 当站点部署在 netlify 时,希望使用 netlify functions 可选择此插件提供支持
|
||||
### 注意
|
||||
|
||||
本主题基于 `VuePress2` ,仍处于 Beta 阶段。
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user