vuepress-theme-plume/docs/README.md

pageLayout, config

pageLayout

config

home

type full background hero hero true tint-plate name tagline text actions Theme Plume VuePress Next Theme 一个简约易用的，功能丰富的 vuepress 文档&博客 主题 theme text link brand 快速开始 → /guide/intro/ theme text link alt Github https://github.com/pengzhanbo/vuepress-theme-plume type features features title icon details 响应式布局 twemoji:laptop-computer 适配移动设备，PC，平板 title icon details 博客 & 文档 twemoji:open-book 无论是想写博客，或想写产品文档，或者两者兼顾 title icon details 开箱即用 twemoji:rocket 支持零配置开箱即用，也支持丰富的自定义配置 title icon details 多语言 twemoji:balance-scale 内置 中文/英文支持，还可以自定义添加更多的语言支持 title icon details 双色主题 twemoji:cityscape 支持 浅色/深色 主题，包括代码高亮 title icon details 插件 twemoji:card-file-box 内置丰富的插件，一站式解决网站一般需求 title icon details 搜索、评论 twemoji:magnifying-glass-tilted-right 支持多种评论系统，支持本地搜索、Algolia搜索 title icon details 加密 twemoji:locked-with-key 支持全站加密、部分加密（加密目录、加密文章） title icon details Markdown 增强 twemoji:writing-hand-light-skin-tone 支持 Markdown 语法，支持 代码块分组、提示容器、任务列表、数学公式、代码演示等 type title description image list image-text 功能 内置丰富的功能，满足网站一般需求。 /images/plume-1.svg title description 文章信息 为文章添加标签、分类、字数统计、阅读时间、写作日期等信息。 title description 评论 支持 4 种评论系统：Giscus、Waline、Twikoo、Artalk<br>你可以自由选择符合你的需求的评论系统。 title description 搜索 支持基于 minisearch 的本地搜索，还支持接入 Algolia 搜索。 title description 加密 支持全站加密、部分加密（加密目录、加密文章）。 title description 代码 代码复制，CodePen演示，JSFiddle演示，CodeSandbox演示，代码组，行高亮，行聚焦，行警告，差异对比，代码块折叠等。 title description 资源嵌入 图表：chart.js/ECharts/Mermaid/flowchart<br>视频：Bilibili/Youtube/ArtPlayer<br>PDF，200K+ Iconify 图标 type title description image list text-image 博客 主题默认支持博客，生成你的个人博客。 /images/plume-2.svg title description 文章列表 通过文章写作日期，自动排序并生成博客文章列表页。 title description 博主信息 自定义名称、座右铭、头像，社交媒体链接。 title description 分类、标签、归档 自动生成分类页、标签页，为文章根据年份进行归档。 type title image description list image-text 文档 /images/plume-3.svg 主题默认支持文档，生成你的产品文档，或归纳你的知识体系。 title description 侧边栏 根据文档目录自动生成侧边栏，也可以手动配置，主题提供了更简单的配置方式。 title description 文档分类归纳 可以文档的不同，归纳到不同的目录，更好的管理文档结构。 type custom

::: center

:::

安装

:::code-tabs @tab pnpm

pnpm add vuepress@next vuepress-theme-plume vue

@tab npm

npm install vuepress@next vuepress-theme-plume

@tab yarn

yarn add vuepress@next vuepress-theme-plume

:::

配置

::: code-tabs @tab .vuepress/config.ts

import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'

export default defineUserConfig({
  // vuepress config...
  theme: plumeTheme({
    // theme config...
  })
})

:::

更新记录

Changelog

贡献者