vuepress-theme-plume/docs/en/README.md

pageLayout, config

pageLayout

config

home

type full effect forceDark hero hero true hyper-speed true name tagline text actions Theme Plume VuePress Next Theme A simple, easy-to-use, feature-rich VuePress documentation & blog theme theme text link brand Get Started → /en/guide/intro/ theme text link alt Github https://github.com/pengzhanbo/vuepress-theme-plume type features features title icon details Responsive Layout twemoji:laptop-computer Adapts to mobile devices, PCs, and tablets title icon details Blog & Documentation twemoji:open-book Whether you want to write a blog, product documentation, or both title icon details Out-of-the-Box twemoji:rocket Supports zero-configuration out-of-the-box, as well as rich customization options title icon details Multi-language twemoji:balance-scale Built-in support for Chinese/English, and you can customize and add more language support title icon details Dual Color Theme twemoji:cityscape Supports light/dark themes, including code highlighting title icon details Plugins twemoji:card-file-box Built-in rich plugins to meet general website needs title icon details Search & Comments twemoji:magnifying-glass-tilted-right Supports multiple comment systems, local search, and Algolia search title icon details Encryption twemoji:locked-with-key Supports full-site encryption and partial encryption (encrypted directories, encrypted articles) title icon details Markdown Enhancement twemoji:writing-hand-light-skin-tone Supports Markdown syntax, code block grouping, hint containers, task lists, mathematical formulas, code demonstrations, etc. type title description image list image-text Features Built-in rich features to meet general website needs. /images/plume-1.svg title description Article Information Add tags, categories, word count, reading time, writing date, and other information to articles. title description Comments Supports 4 comment systems： Giscus, Waline, Twikoo, Artalk<br>You can freely choose the comment system that suits your needs. title description Search Supports local search based on minisearch, and also supports Algolia search. title description Encryption Supports full-site encryption and partial encryption (encrypted directories, encrypted articles). title description Code Code copying, CodePen demonstration, JSFiddle demonstration, CodeSandbox demonstration, code groups, line highlighting, line focusing, line warnings, difference comparison, code block folding, etc. title description Resource Embedding Charts：chart.js/ECharts/Mermaid/flowchart<br>Videos：Bilibili/Youtube/ArtPlayer<br>PDF, 200K+ Iconify icons type title description image list text-image Blog The theme supports blogs by default, allowing you to create your personal blog. /images/plume-2.svg title description Article List Automatically sorts and generates a blog article list page based on the article writing date. title description Blogger Information Customize name, motto, avatar, and social media links. title description Categories, Tags, Archives Automatically generates category pages, tag pages, and archives articles by year. type title image description list image-text Documentation /images/plume-3.svg The theme supports documentation by default, allowing you to create product documentation or organize your knowledge system. title description Sidebar Automatically generates a sidebar based on the documentation directory, or you can manually configure it. The theme provides a simpler configuration method. title description Documentation Classification You can categorize different documents into different directories for better management of the documentation structure. type custom

::: center

:::

Installation

:::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

:::

Configuration

::: 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...
  })
})

:::

Update Log

Changelog

Contributors