@mr-hope/vuepress-plugin-theme-colordeprecated

theme-color plugin for vuepress-theme-hope

Usage no npm install needed!

<script type="module">
  import mrHopeVuepressPluginThemeColor from 'https://cdn.skypack.dev/@mr-hope/vuepress-plugin-theme-color';
</script>

README

@mr-hope/vuepress-plugin-theme-color

Version Downloads Size

Theme-color plugin for vuepress-theme-hope. You can also use it on @vuepress/theme-default.

Usage

npm i @mr-hope/vuepress-plugin-theme-color

This plugin will provide a <ThemeColor /> compoenent for you.

Options

  • picker

    • Type: Object | false

    • Default:

      {
        blue: '#2196f3',
        red: '#f26d6d',
        green: '#3eaf7c',
        orange: '#fb9b5f'
      }
      

You can use false to disable it.

  • allowDarkmode

    • Type: Boolean
    • Default: true

    Wether to enable darkmode

Note

In order to let the stylus compiler to work, you also need to assign the color variable to $colorPicker and write it to .vuepress/styles/palette.styl:

// .vuepress/styles/palette.styl
$colorPicker = {
   colorName1: red,
   colorName2: yellow,
   colorName3: blue
}

vuepress-theme-hope 的 主题色与夜间模式 插件。你也可以在默认主题上使用它。

使用

npm i @mr-hope/vuepress-plugin-theme-color

插件将会提供 <ThemeColor /> 组件。

选项

  • picker

    • 类型: Object | false

    • 默认值:

      {
        blue: '#2196f3',
        red: '#f26d6d',
        green: '#3eaf7c',
        orange: '#fb9b5f'
      }
      

你也设置为 false 将其禁用。

  • allowNightmode

    • 类型: Boolean
    • 默认值: true

    是否启用夜间模式

注意

为了使 stylus 编译器正常工作,你还需要将颜色变量赋值给 $colorPicker 写入 .vuepress/styles/palette.styl 中:

// .vuepress/styles/palette.styl
$colorPicker = {
  colorName1: red,
  colorName2: yellow,
  colorName3: blue
}