vuepress-plume-config

name	vuepress-plume-config
description	Generate and write VuePress Plume theme config. Invoke when user asks to init or update theme config, including collections, navbar, sidebar, locales, plugins, and all theme features like search, comments, watermark, encryption, bulletin, copyright, llmstxt, replaceAssets, etc.

VuePress Plume Config Skill

This skill generates, manages, and writes VuePress Plume theme configuration files based on the official documentation. It supports .vuepress/config.ts, .vuepress/config.js, and .vuepress/plume.config.ts.

When to Invoke

• Initialize or update Plume theme configuration
• Configure collections (post/doc types), navbar, sidebar, locales
• Setup plugins (search, comments, watermark, llmstxt, etc.)
• Configure encryption, bulletin, copyright, and other advanced features
• Write the generated configuration into a specified target file

Documentation Sources

• Theme Configuration
• Locales Configuration
• Collections Configuration
• Navbar
• Sidebar
• Markdown
• Plugins
• Frontmatter - Basic
• Frontmatter - Post
• Frontmatter - Home
• Frontmatter - Friend

Configuration Files

The theme supports two configuration approaches:

1. .vuepress/config.ts (Recommended for full control)

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

export default defineUserConfig({
  // Site-level config: lang, title, description, base, head, locales
  theme: plumeTheme({
    // Full theme config available, including plugins, markdown, search, comment, etc.
  })
})

2. .vuepress/plume.config.ts (Recommended for clean separation)

import { defineThemeConfig } from 'vuepress-theme-plume'

export default defineThemeConfig({
  // Supported fields: hostname, home, logo, logoDark, appearance, profile, social,
  // navbarSocialInclude, navbar, collections, sidebar, sidebarScrollbar, aside, outline,
  // transition, footer, bulletin, copyright, prevPage, nextPage, createTime, locales,
  // docsRepo/docsBranch/docsDir, autoFrontmatter, editLinkPattern
})

::: warning Fields NOT supported in plume.config.ts plugins, markdown, codeHighlighter, search, comment, watermark, readingTime, copyCode, replaceAssets, editLink, lastUpdated, contributors, changelog, cache, hostname, configFile, encrypt, llmstxt :::

Input Schema

{
  "type": "object",
  "required": ["format", "target_file"],
  "properties": {
    "format": {
      "type": "string",
      "enum": ["plume-config-ts", "vuepress-config-ts", "vuepress-config-js"],
      "description": "Output file type and configuration style"
    },
    "target_file": {
      "type": "string",
      "description": "Target file path to write (relative to project root or absolute)"
    },
    "site": {
      "type": "object"
       
       
              
            
            
            
            
            
      
    
     
       
       
       
              
              
         
            
                  
           
                   
                  
                  
          
        
         
            
             
           
        
              
              
              
              
              
         
            
                   
        
               
               
               
               
               
         
            
              
           
        
         
           
           
                
                
                
                
                
                
                     
          
        
         
            
           
           
             
             
                   
                  
                  
            
              
          
        
         
           
              
              
        
         
           
           
           
              
             
                  
                  
                  
                  
                   
                   
                  
            
          
        
         
           
           
           
           
             
               
             
                     
                  
                  
                  
                        
                   
                       
                       
                    
                  
                    
                    
                  
                  
                    
                  
                  
                    
                  
                  
                     
                  
                   
                   
                   
                   
                    
                    
            
          
        
             
              
                   
                  
         
            
           
           
                  
                  
                   
          
        
         
            
           
           
                
                
          
        
         
            
           
           
                        
                  
                 
                      
                
                
                
                     
                
          
        
         
             
           
           
                 
                 
                      
          
        
              
              
                   
            
            
            
             
             
             
             
             
             
             
             
         
            
           
                  
                     
                
          
        
      
    
  

Collections Configuration

Collections are the core concept for organizing content. Each collection points to a specific folder in the source directory.

Post Collection (Blog, Columns)

{
  type: 'post',
  dir: 'blog',
  title: '博客',
  link: '/blog/',
  linkPrefix: '/article/',
  postCover: 'top', // 'left' | 'right' | 'odd-left' | 'odd-right' | 'top'
  tags: true,
  archives: true,
  categories: true,
  pagination: { perPage: 15 },
  profile: { name: '博主', avatar: '/avatar.png' },
  social: [{ icon: 'github', link: 'https://github.com/username' }]
}

Doc Collection (Documentation, Notes)

{
  type: 'doc',
  dir: 'guide',
  title: '指南',
  sidebar: 'auto', // or manual sidebar config
  sidebarScrollbar: true,
  sidebarCollapsed: false
}

Built-in Plugins

The theme includes these plugins (configured in plugins field):

Plugin	Description
@vuepress/plugin-nprogress	Page loading progress bar
@vuepress/plugin-photo-swipe	Image preview
@vuepress/plugin-reading-time	Article reading time
@vuepress/plugin-watermark	Article watermark
@vuepress-plume/plugin-search	Local search
@vuepress/plugin-docsearch	Algolia DocSearch
@vuepress/plugin-copy-code	Code copy
@vuepress/plugin-shiki	Code highlighting
@vuepress/plugin-comment	Article comments
@vuepress/plugin-markdown-hint	Markdown hints
@vuepress/plugin-markdown-image	Markdown image
@vuepress/plugin-markdown-math	Markdown math
@vuepress/plugin-markdown-include	Markdown include
@vuepress/plugin-markdown-chart	Markdown charts (chartjs/echarts/mermaid/flowchart/markmap/plantuml)
@vuepress/plugin-replace-assets	Asset link replacement
vuepress-plugin-md-power	Markdown Power
@vuepress/plugin-git	Git commit info
@vuepress/plugin-cache	Page compilation cache
@vuepress/plugin-seo	SEO optimization
@vuepress/plugin-sitemap	Sitemap
@vuepress/plugin-llms	LLMs txt support

Markdown Configuration

Configure markdown features in markdown field:

markdown: {
  hint: true,        // Info, tip, warning, caution containers
  alert: true,       // GitHub-style alerts
  fileTree: true,    // File tree container
  plot: true,        // Hidden text (spoiler)
  icons: true,       // Icons support
  math: { type: 'katex' }, // Math formulas
  include: true,     // Include markdown files
  annotation: false, // Inline annotations
  abbr: false,       // Abbreviations
  mark: 'eager',     // Mark/highlight text
  codeTabs: true,    // Code block tabs
  tabs: true,        // General tabs
  npmTo: false,      // npm/yarn/pnpm switcher
  timeline: false,   // Timeline container
  collapse: false,   // Collapsible sections
  chat: false,       // Chat dialog
  demo: false,       
  : ,        
  : ,   
  : ,    
  : ,  
  : ,
  : ,    
  : ,
  : ,   
  : ,       
  : ,    
  : ,  
  : ,    
  : ,    
  : ,    
  : ,    
  : ,   
  : ,  
}

Code Highlighter Configuration

codeHighlighter: {
  lineNumbers: true,      // Enable line numbers globally
  whitespace: false,      // Show whitespace globally
  collapsedLines: false,  // Collapse lines globally
  theme: { light: 'github-light', dark: 'github-dark' },
  languages: ['js', 'ts', 'vue', 'bash', 'json'],
  twoslash: false,        // TypeScript twoslash
}

Search Configuration

Local Search (Default)

search: {
  provider: 'local',
  // Additional options...
}

Algolia DocSearch

search: {
  provider: 'algolia',
  appId: 'YOUR_APP_ID',
  apiKey: 'YOUR_API_KEY',
  indexName: 'YOUR_INDEX_NAME'
}

Comments Configuration

Giscus

comment: {
  provider: 'Giscus',
  repo: 'owner/repo',
  repoId: '...',
  category: 'Announcements',
  categoryId: '...'
}

Waline

comment: {
  provider: 'Waline',
  serverURL: 'https://your-waline-server.vercel.app'
}

Twikoo

comment: {
  provider: 'Twikoo',
  envId: 'your-env-id'
}

Artalk

comment: {
  provider: 'Artalk',
  server: 'https://your-artalk-server.com'
}

LLMs txt Configuration

Generate LLM-friendly content for AI assistants:

llmstxt: {
  locale: '/',
  // Additional options...
}

This generates:

• /llms.txt - Brief overview with links
• /llms-full.txt - Full content
• Individual markdown files for each page

Encryption Configuration

Global Encryption

encrypt: {
  global: true,
  admin: ['password1', 'password2']
}

Partial Encryption

encrypt: {
  rules: {
    'secret/': 'password',
    '/article/secret/': ['pass1', 'pass2'],
    '^/private/': 'private-pass' // Regex pattern
  }
}

Watermark Configuration

watermark: {
  enabled: true,
  content: 'Your Name',
  opacity: 0.1,
  zIndex: 999
}

Replace Assets Configuration

Replace asset URLs for CDN deployment:

replaceAssets: {
  image: 'https://cdn.example.com/images/',
  js: 'https://cdn.example.com/js/'
}

Common Configuration Patterns

Blog Setup

export default defineUserConfig({
  theme: plumeTheme({
    collections: [
      {
        type: 'post',
        dir: 'blog',
        title: '博客',
        link: '/blog/',
        postCover: 'right',
        tags: true,
        archives: true,
        categories: true
      }
    ],
    profile: {
      name: '博主名称',
      description: '博主描述',
      avatar: '/avatar.png'
    },
    social: [
      { icon: 'github', link: 'https://github.com/username' }
    ]
  })
})

Documentation Setup

export default defineUserConfig({
  theme: plumeTheme({
    collections: [
      {
        type: 'doc',
        dir: 'guide',
        title: '指南',
        sidebar: 'auto'
      }
    ],
    navbar: [
      { text: '指南', link: '/guide/', icon: 'mdi:book-open-outline' }
    ]
  })
})

Multi-language Setup

export default defineUserConfig({
  locales: {
    '/': { lang: 'zh-CN', title: '中文站点' },
    '/en/': { lang: 'en-US', title: 'English Site' }
  },
  theme: plumeTheme({
    locales: {
      '/': {
        selectLanguageName: '简体中文',
        collections: [
          { type: 'doc', dir: 'guide', title: '指南', sidebar: 'auto' }
        ]
      },
      '/en/': {
        selectLanguageName: 'English',
        collections: [
          { type: 'doc', dir: 'en/guide', title: 'Guide', sidebar: 'auto' }
        ]
      }
    }
  })
})

Validation and Hints

• Check consistency between format and target_file extension
• If format=plume-config-ts and input contains fields only supported in config.ts/js:
  • Exclude these fields: plugins, markdown, codeHighlighter, search, comment, watermark, readingTime, copyCode, replaceAssets, editLink, lastUpdated, contributors, changelog, cache, hostname, configFile, encrypt, llmstxt
  • Report them as ignored with reasons
• In collections, type must be post or doc; dir and title are required
• navbar accepts strings (paths) and objects (with text/link)
• Keys in locales should be path prefixes like '/', '/en/', '/zh/'
• For encrypt.rules, keys can be: file paths, directory paths, URL paths, or regex patterns (starting with ^)
• For copyright, support both preset licenses (CC-BY-4.0, etc.) and custom { name, url } format

Execution Feedback

• Written file path and format type
• Summary of generated fields (collections count, navbar items, locales count)
• Ignored fields list with reasons
• For cache to take effect, remind removing --clean-cache from dev script
• For encrypt to work properly, remind HTTPS requirement for partial content encryption

References

• Theme: theme.md
• Locales: locales.md
• Collections: collections.md
• Navbar: navbar.md
• Sidebar: sidebar.md
• Markdown: markdown.md
• Plugins: plugins/README.md
• Encryption: encryption.md
• Bulletin: bulletin.md
• Copyright: copyright.md
• LLMs txt: llmstxt.md