# vuepress-plugin-ribbon

🎗 Add a beautiful ribbon to your vuepress!

npm GitHub stars downloads downloads GitHub license

# Install

yarn add vuepress-plugin-ribbon -D
# or use npm
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
      }
    ]
  ]
}

# Thanks

Made with ❤️ by Ahmad Mostafa - @z3by