vuepress-lovely-plugins

Add some lovely plugins in your vuepress!

Get started!

# Get Started!

# vuepress-plugin-ribbon

npm GitHub stars downloads downloads GitHub license

GitHub

πŸŽ— Add a beautiful ribbon in your vuepress!

# Install

yarn add vuepress-plugin-ribbon -D
# or
npm i vuepress-plugin-ribbon -D

# Usage

module.exports = {
  plugins: ['ribbon']
}

# Options

module.exports = {
  plugins: [
    [
      "ribbon",
      {
        size: 90,     // width of the ribbon, default: 90
        opacity: 0.8, // opacity of the ribbon, default: 0.3
        zIndex: -1    // z-index property of the background, default: -1
      }
    ]
  ]
}

# vuepress-plugin-cursor-effects

npm GitHub stars downloads downloads GitHub license

GitHub

πŸŽ‰ Add a lovely cursor effects in your vuepress!

# Install

yarn add vuepress-plugin-cursor-effects -D
# or use npm
npm i vuepress-plugin-cursor-effects -D

# Usage

module.exports = {
  plugins: ['cursor-effects']
}

# Options

module.exports = {
  plugins: [
    [
      "cursor-effects",
      {
        size: 2,                    // size of the particle, default: 2
        shape: ['star'| 'circle'],  // shape of the particle, default: 'star'
        zIndex: 999999999           // z-index property of the canvas, default: 999999999
      }
    ]
  ]
}

# vuepress-plugin-dynamic-title

npm GitHub stars downloads downloads GitHub license

GitHub

πŸ‘€ Add a dynamic title in your vuepress!

# Install

yarn add vuepress-plugin-dynamic-title -D
# or use npm
npm i vuepress-plugin-dynamic-title -D

# Usage

module.exports = {
  plugins: ['dynamic-title']
}

# Options

module.exports = {
  plugins: [
    [
      "dynamic-title",
      {
        showIcon: "/favicon.ico",
        showText: "(/≧▽≦/)ε’¦οΌεˆε₯½δΊ†οΌ",
        hideIcon: "/failure.ico",
        hideText: "(●—●)ε–”ε“ŸοΌŒε΄©ζΊƒε•¦οΌ",
        recoverTime: 2000
      }
    ]
  ]
}

# vuepress-plugin-go-top

npm GitHub stars downloads downloads GitHub license

GitHub

🐾 Click such a lovely cat to back to top!

# Install

yarn add vuepress-plugin-go-top -D
# or use npm
npm i vuepress-plugin-go-top -D

# Usage

module.exports = {
  plugins: ['go-top']
}

# Thanks