hexo-plugin-cookieconsent

A hexo plugin for quickly adding the orestbida/cookieconsent lightweight JavaScript plugin for alerting users about the use of cookies on your website.

Installation

$ npm i hexo-plugin-cookieconsent

Usage

Inside your hexo _config.yml file.

cookieconsent:
  enable: true

The plugin has several options.

Custom CSS and JS URLs

You can specify custom URLs for the CSS and JS files. This allows you to use local files or even other cookie consent libraries:

cookieconsent:
  enable: true
  jsUrl: "/js/cookieconsent.umd.js"  # Optional: custom JS file URL
  cssUrl: "/css/cookieconsent.css"   # Optional: custom CSS file URL
  priority: 10                        # Optional: filter execution priority (default: 10)

To download the files locally from one of the cookie consent library:

• JS: https://cdn.jsdelivr.net/gh/orestbida/[email protected]/dist/cookieconsent.umd.js
• CSS: https://cdn.jsdelivr.net/gh/orestbida/[email protected]/dist/cookieconsent.css

If not specified, the plugin will use the default CDN URLs.

Disable JS Injection

You can disable JavaScript injection when the JS is concatenated with other scripts for performance:

cookieconsent:
  enable: true
  injectJs: false  # Optional: disable JS injection (default: true)
  priority: 10     # Optional: filter execution priority (default: 10)

When injectJs is set to false, you'll need to manually include the cookie consent library and call CookieConsent.run(options) in your own scripts.

Options

Go to: https://playground.cookieconsent.orestbida.com/

Create your cookieconsent how you want it using the form. Paste the configuration into your hexo _config.yml file under "options". The plugin automatically detects and supports both JSON and YAML formats.

JSON Format

cookieconsent:
  enable: true
  jsUrl: "/js/cookieconsent.umd.js"  # Optional
  cssUrl: "/css/cookieconsent.css"   # Optional
  injectJs: false                     # Optional: disable JS injection
  options: {
             "palette": {
               "popup": {
                 "background": "#eb6c44",
                 "text": "#ffffff"
               },
               "button": {
                 "background": "#f5d948"
               }
             },
             "theme": "classic",
             "position": "top",
             "static": true,
             "content": {
               "message": "This website uses cookies to ensure you get the best experience on our website. Who doesn't like cookies?",
               "dismiss": "Feed me",
               "link": "Cookie recipes",
               "href": "neo01.com"
             }
           }

YAML Format

cookieconsent:
  enable: true
  jsUrl: "/js/cookieconsent.umd.js"  # Optional
  cssUrl: "/css/cookieconsent.css"   # Optional
  injectJs: false                     # Optional: disable JS injection
  options:
    palette:
      popup:
        background: "#eb6c44"
        text: "#ffffff"
      button:
        background: "#f5d948"
    theme: "classic"
    position: "top"
    static: true
    content:
      message: "This website uses cookies to ensure you get the best experience on our website. Who doesn't like cookies?"
      dismiss: "Feed me"
      link: "Cookie recipes"
      href: "neo01.com"

The script is inserted during hexo generate so don't forget:

hexo generate