VuePress EcosystemVuePress Ecosystem
  • Theme Guidelines
  • theme-default
  • Hope Theme
  • Plume Theme
  • Reco Theme
  • Feature Plugins
  • Markdown Plugins
  • Search Plugins
  • Blog Plugins
  • PWA Plugins
  • Analytics Plugins
  • SEO Plugins
  • Development Plugins
  • Tool Plugins
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • Theme Guidelines
  • theme-default
  • Hope Theme
  • Plume Theme
  • Reco Theme
  • Feature Plugins
  • Markdown Plugins
  • Search Plugins
  • Blog Plugins
  • PWA Plugins
  • Analytics Plugins
  • SEO Plugins
  • Development Plugins
  • Tool Plugins
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • active-header-links
  • git
  • palette
  • reading-time
  • rtl
  • Sass Palette
    • Guide
    • Config
  • theme-data
  • toc

sass-palette

@vuepress/plugin-sass-palette

This plugin is mainly facing plugin and theme developers, it is more powerful than @vuepress/plugin-palette.

Tips

You should manually install these deps in your project:

  • When using Vite bundler: sass-embedded
  • When using Webpack bundler: sass-embedded and sass-loader

Usage

You must invoke useSassPalettePlugin function during plugin initialization to use this plugin.

npm i -D @vuepress/plugin-sass-palette@next
Your plugin or theme entry
import { useSassPalettePlugin } from 'vuepress-plugin-sass-palette'

export const yourPlugin = (options) => (app) => {
  useSassPalettePlugin(app, {
    // plugin options
  })

  return {
    // your plugin api
  }
}
Edit this page on GitHub
Last Updated:: 1/10/25, 6:07 PM
Contributors: Mister-Hope, meteorlxy, pengzhanbo
Prev
rtl
Next
theme-data