vuepress-theme-plume/readme.md

@vuepress-plume/vuepress-theme-plume

一个简约的 vuepress 主题。

开箱即用，仅需少量配置即可使用。

查看文档

Install

yarn add vuepress@next @vuepress-plume/vuepress-theme-plume

Usage

import { defineUserConfig } from 'vuepress'
import { plumeTheme } from '@vuepress-plume/vuepress-theme-plume'
export default defineUserConfig({
  theme: plumeTheme({
    // theme config
  })
})

plumeTheme(options)

options : PlumeThemeOptions

查看 options 详细说明

案例

• 我的个人博客

效果图

内置插件

• plugin-caniuse 在文档中使用 caniuse 提供的 web feature support list
• plugin-auto-frontmatter 在 md 文件中根据匹配规则自动生成 frontmatter
• plugin-notes-data 根据规则，将 md文件归类为 note，并生成 sidebar
• plugin-blog-data 根据规则，将md文件归类为 blog post，并生成 post list
• vuepress-plugin-mdEnhance 增强markdown功能插件
• vuepress-plugin-comment 文章评论插件，支持 "giscus" | "twikoo" | "waline"
• vuepress-plugin-copy-code 文章内代码块复制插件
• vuepress-plugin-medium-zoom 图片预览插件
• vuepress-plugin-prismjs 代码块高亮插件
• vuepress-plugin-search 内容搜索插件
• vuepress-plugin-docsearch Algolia docsearch 内容搜索插件
• vuepress-plugin-palette 主题调色板插件
• vuepress-plugin-seo seo 插件
• vuepress-plugin-sitemap 生成sitemap 插件

非内置插件

• vuepress-plugin-netlify-functions 当站点部署在 netlify 时，希望使用 netlify functions 可选择此插件提供支持

注意

本主题基于 VuePress2 ，仍处于 Beta 阶段。

这意味着功能尚未完善，在未来有概率发生破坏性更改。