Skip to content

Theme Plume

VuePress Next Theme

A simple, easy-to-use, feature-rich VuePress documentation & blog theme

Features

Built-in rich features to meet general website needs.

  • Article Information

    Add tags, categories, word count, reading time, writing date, and other information to articles.

  • Comments

    Supports 4 comment systems: Giscus, Waline, Twikoo, Artalk
    You can freely choose the comment system that suits your needs.

  • Search

    Supports local search based on minisearch, and also supports Algolia search.

  • Encryption

    Supports full-site encryption and partial encryption (encrypted directories, encrypted articles).

  • Code

    Code copying, CodePen demonstration, JSFiddle demonstration, CodeSandbox demonstration, code groups, line highlighting, line focusing, line warnings, difference comparison, code block folding, etc.

  • Resource Embedding

    Charts:chart.js/ECharts/Mermaid/flowchart
    Videos:Bilibili/Youtube/ArtPlayer
    PDF, 200K+ Iconify icons

Blog

The theme supports blogs by default, allowing you to create your personal blog.

  • Article List

    Automatically sorts and generates a blog article list page based on the article writing date.

  • Blogger Information

    Customize name, motto, avatar, and social media links.

  • Categories, Tags, Archives

    Automatically generates category pages, tag pages, and archives articles by year.

Documentation

The theme supports documentation by default, allowing you to create product documentation or organize your knowledge system.

  • Sidebar

    Automatically generates a sidebar based on the documentation directory, or you can manually configure it. The theme provides a simpler configuration method.

  • Documentation Classification

    You can categorize different documents into different directories for better management of the documentation structure.

GitHub Repo starsnpm versionnpm downloadsnpm downloadsgithub license

peer dependencycodecov

Installation

pnpm
pnpm add vuepress@next vuepress-theme-plume vue

Configuration

.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