Plume Theme

English

简体中文

English

简体中文

Appearance

Star on GitHubCreate IssuesBuy me a Bubble Tea

Markdown Configuration

Copy page

About 710 wordsAbout 2 min

2025-10-09

Overview

Markdown configuration is used to control the behavior of Markdown. This configuration aggregates various feature configurations provided by the theme for Markdown enhancements.

.vuepress/config.ts
import { 
defineUserConfig
 } from 'vuepress'
import { 
plumeTheme
 } from 'vuepress-theme-plume'

export default 
defineUserConfig
({
  
theme
: 
plumeTheme
({
    
markdown
: {
      // Configure markdown here
    },
  }),
})

Warning

Do not confuse this with VuePress's markdown configuration.

These two are independent. Do not configure the theme's markdown settings within VuePress > markdown, and vice versa.

Default Configuration:

.vuepress/config.ts
import { 
defineUserConfig
 } from 'vuepress'
import { 
plumeTheme
 } from 'vuepress-theme-plume'

export default 
defineUserConfig
({
  
theme
: 
plumeTheme
({
    
markdown
: {
      
hint
: true,
      
alert
: true,
      
fileTree
: true,
      
plot
: true,
      
icons
: true,
      
math
: { 
type
: 'katex' },
      
include
: {
        // ...option
      },
    },
  }),
})

Configuration Options

Tips

The hint and alert features are implemented by the @vuepress/plugin-markdown-hint plugin.

hint

  • Type: boolean
  • Default: true
  • Details: Whether to enable hint containers.

alert

  • Type: boolean
  • Default: true
  • Details: Whether to enable GitHub-style alert syntax.

Tips

The image configuration is implemented by the @vuepress/plugin-markdown-image plugin.

image

  • Type: boolean | MarkdownImagePluginOptions
  • Default: false
  • Details: Whether to enable image enhancement syntax.

Tips

The math configuration is implemented by the @vuepress/plugin-markdown-math plugin.

math

  • Type: boolean | MarkdownMathPluginOptions
  • Default: { type: 'katex' }
  • Details: Whether to enable math support.

include

Tips

The include configuration is implemented by the @vuepress/plugin-markdown-include plugin.

  • Type: boolean | MarkdownIncludePluginOptions
  • Default: true
  • Details: Whether to enable Markdown file inclusion.

The following configuration fields are implemented by the vuepress-plugin-md-power plugin.

annotation

  • Type: boolean
  • Default: false
  • Details: Whether to enable content annotations.

abbr

  • Type: boolean
  • Default: false
  • Details: Whether to enable abbreviation syntax.

mark

  • Type: MarkOptions
  • Default: 'eager'
  • Details: Sets when the ==mark== animation runs.

codeTabs

  • Type: boolean | CodeTabsOptions
  • Default: true
  • Details: Whether to enable code block grouping.

tabs

  • Type: boolean | TabsOptions
  • Default: true
  • Details: Whether to enable grouping.

npmTo

  • Type: boolean | NpmToOptions
  • Default: false
  • Details: Whether to enable the npm-to container.

icon

plot

  • Type: boolean | PlotOptions
  • Default: true
  • Details: Whether to enable hidden text syntax.

fileTree

  • Type: boolean | FileTreeOptions
  • Default: true
  • Details: Whether to enable file tree container syntax.

field

  • Type: boolean
  • Default: false
  • Details: Whether to enable field containers.

table

  • Type: boolean | TableContainerOptions
  • Default: false
  • Details: Whether to enable enhanced table containers.

timeline

  • Type: boolean
  • Default: false
  • Details: Whether to enable timeline container syntax.

collapse

  • Type: boolean
  • Default: false
  • Details: Whether to enable collapsible panel container syntax.

chat

  • Type: boolean
  • Default: false
  • Details: Whether to enable chat record containers.

demo

  • Type: boolean
  • Default: false
  • Details: Whether to enable Demo containers.

pdf

  • Type: boolean | PdfOptions
  • Default: false
  • Details: Whether to enable PDF embedding syntax.

bilibili

  • Type: boolean
  • Default: false
  • Details: Whether to enable Bilibili video embedding syntax.

youtube

  • Type: boolean
  • Default: false
  • Details: Whether to enable YouTube video embedding syntax.

artPlayer

  • Type: boolean
  • Default: false
  • Details: Whether to enable ArtPlayer video embedding syntax.

audioReader

  • Type: boolean
  • Default: false
  • Details: Whether to enable Audio Reader audio embedding syntax.

codepen

  • Type: boolean
  • Default: false
  • Details: Whether to enable CodePen embedding syntax.

codeSandbox

  • Type: boolean
  • Default: false
  • Details: Whether to enable CodeSandbox embedding syntax.

jsfiddle

  • Type: boolean
  • Default: false
  • Details: Whether to enable JS Fiddle embedding syntax.

repl

  • Type: boolean | ReplOptions
  • Default: false
  • Details: Whether to enable Repl container syntax.

caniuse

  • Type: boolean
  • Default: false
  • Details: Whether to enable Can I Use embedding syntax.

imageSize

  • Type: boolean | 'local' | 'all'
  • Default: false
  • Details: Whether to enable automatic filling of image width and height attributes.

Tips

The following configuration fields are implemented by the @vuepress/plugin-markdown-chart plugin.

chartjs

  • Type: boolean
  • Default: false
  • Details: Whether to enable Chart.js chart embedding syntax.

echarts

  • Type: boolean
  • Default: false
  • Details: Whether to enable ECharts chart embedding syntax.

mermaid

  • Type: boolean
  • Default: false
  • Details: Whether to enable Mermaid diagram embedding syntax.

markmap

  • Type: boolean
  • Default: false
  • Details: Whether to enable Markmap diagram embedding syntax.

plantuml

  • Type: boolean
  • Default: false
  • Details: Whether to enable PlantUML diagram embedding syntax.

flowchart

  • Type: boolean
  • Default: false
  • Details: Whether to enable Flowchart diagram embedding syntax.

Contributors

pengzhanboHonahec

Changelog

10/12/25, 1:56 PM
View All Changelog
  • 5c0d2-feat(plugin-md-power): add lazy animation mode for mark highlights (#718)on
  • 38505-docs: update en docs (#708)on