Environment Requirements

• Node.js: ^20.6.0 or >= 22.0.0
• Package Manager: npm 8+, pnpm 8+, or Yarn 2+

How to Install Environment Dependencies?

1. Download Node.js

   Visit the Node.js official website to download the latest stable version. Follow the installation wizard to complete the installation (typically keeping the default settings is sufficient).

2. Enable PNPM

   After installation, open the terminal and execute the following command:

   corepack enable

   We recommend using pnpm as the package manager.

3. Environment Ready

Command Line Installation Recommended

We provide a command-line tool for quickly setting up a basic project structure. Execute the following command to start the installation wizard:

pnpm

pnpm create vuepress-theme-plume@latest

yarn

yarn create vuepress-theme-plume@latest

npm

npm create vuepress-theme-plume@latest

After launching, simply answer a few simple questions to complete the configuration:

┌  Welcome to VuePress and vuepress-theme-plume !
│
◇  Select a language to display / 选择显示语言
│  Simplified Chinese
│
◇  Where do you want to initialize VuePress? 
│  ./my-project
│
◇  Site name: 
│  My Vuepress Site
│
◇  Site description: 
│  My Vuepress Site Description
│
◇  Use multiple languages? 
│  No
│
◇  Select the default language for the site 
│  Simplified Chinese
│
◇  Use TypeScript? 
│  Yes
│
◇  Select the bundler tool 
│  Vite
│
◇  Deployment method: 
│  Custom
│
◇  Initialize git repository? 
│  Yes
│
◇  Install dependencies? 
│  Yes
│
◇   🎉  Creation successful! 
│
└  🔨  Start with the following commands:
      cd ./my-project
      pnpm run docs:dev

Command Line Tool Usage Guide

Using Windows as an example:

1. Press Win + R to open the "Run" dialog
2. Enter cmd or powershell and press Enter

If the current directory is incorrect, use the following commands to switch:

D:                    # Switch to D drive (adjust according to your situation)
cd open-source        # Enter the target directory

You can then execute pnpm create vuepress-theme-plume@latest to create the project. The project will be located in the D:\open-source\my-project directory.

Manual Installation

Important Notes

• When using pnpm, vue must be additionally installed as peer-dependencies
• When using Yarn 2+, set nodeLinker: 'node-modules' in .yarnrc.yml

If manual installation is required, follow these steps:

• Create Project Directory

  mkdir my-blog
  cd my-blog

• Initialize Project

  pnpm

  git init
  pnpm init

  yarn

  git init
  yarn init

  npm

  git init
  npm init

• Install Core Dependencies

  Install vuepress@next and the theme package:

  pnpm

  # Install VuePress
  pnpm add -D vuepress@next vue
  # Install theme and build tool
  pnpm add -D vuepress-theme-plume @vuepress/bundler-vite@next

  yarn

  # Install VuePress
  yarn add -D vuepress@next vue
  # Install theme and build tool
  yarn add -D vuepress-theme-plume @vuepress/bundler-vite@next

  npm

  # Install VuePress
  npm i -D vuepress@next vue
  # Install theme and build tool
  npm i -D vuepress-theme-plume @vuepress/bundler-vite@next

  Version Compatibility

  The current theme is adapted to [email protected]. Using other versions may cause compatibility issues.

• Configure Build Scripts

  Add the following to package.json:

  package.json

  {
    "scripts": {
      "docs:dev": "vuepress dev docs",
      "docs:build": "vuepress build docs"
    }
  }

  VuePress uses the docs directory as the documentation root by default.

• Configure Git Ignore Rules

  .gitignore

  node_modules
  .temp
  .cache

  sh

  echo 'node_modules' >> .gitignore
  echo '.temp' >> .gitignore
  echo '.cache' >> .gitignore

• Configure Theme

  docs/.vuepress/config.ts

  import { 
  viteBundler
   } from '@vuepress/bundler-vite'
  import { 
  defineUserConfig
   } from 'vuepress'
  import { 
  plumeTheme
   } from 'vuepress-theme-plume'
  
  export default 
  defineUserConfig
  ({
    // Default language must be set
    
  lang
  : 'zh-CN',
    
  theme
  : 
  plumeTheme
  ({
      // Theme configuration...
    }),
    
  bundler
  : 
  viteBundler
  (),
  })

  Language Configuration Required

  Regardless of whether multiple languages are used, the lang option must be correctly configured. The theme relies on this setting to determine the text language environment.

• Create Homepage Document

  README.md

  ---
  home: true
  ---

• Start Development Server

  pnpm

  pnpm docs:dev

  yarn

  yarn docs:dev

  npm

  npm run docs:dev

  VuePress will start a development server at http://localhost:8080 with hot-reload support for Markdown files.

• Installation Complete

Theme Update

Use the following command to check and update the theme:

pnpm

pnpm dlx vp-update

yarn

yarn dlx vp-update

npm

npx vp-update

Contributors

pengzhanbozhenghaoyang24

Changelog

10/9/25, 7:46 AM

View All Changelog

• 38505-docs: update en docs (#708)on 10/9/25
• 4d236-feat(theme)!: add collections support (#704)on 10/7/25
• 729a0-feat!: drop node18 support, close #574 (#575)on 4/28/25
• 497fe-docs: fix markdown formatting and update snippet path in usage guideon 3/29/25
• 9f99a-docs: add en markdown doc (#538)on 3/27/25
• a4ac3-docs: add en-US docs (#514)on 3/9/25
• bf9ef-docs: update docson 9/1/24