platzky-promocode

A platzky plugin that adds a click-to-reveal promo code button.

The promo code is never present as plain text in the page — it is base64-encoded and decoded client-side only on click.

Installation

pip install platzky_promocode

Configuration

Plugins are configured in platzky's database, under a top-level plugins object keyed by plugin name (for the JSON database that is inside DB.DATA; the GraphQL and MongoDB backends store the same structure):

{
    "plugins": {
        "promocode": {
            "is_active": true,
            "allowed_content_types": ["post", "page", "field"],
            "config": {
                "text": "Reveal your discount",
                "color": "#e63946"
            }
        }
    }
}

The key (promocode) must match the plugin's entry-point name.

allowed_content_types is enforced by the engine and intersected with the content types the plugin supports (post, page, field), so it can only narrow them, never widen them.

Plugin settings (config)

Translated button labels

text can be a map of locale codes to labels instead of a single string. The label matching the visitor's active locale is used, falling back to the first entry in the map when there is no match:

{
    "plugins": {
        "promocode": {
            "is_active": true,
            "allowed_content_types": ["post", "page", "field"],
            "config": {
                "text": {
                    "en": "Reveal Promo Code",
                    "pl": "Pokaż kod promocyjny",
                    "uk": "Показати промокод"
                }
            }
        }
    }
}

Usage in blog content

Embed the promo code directly in post content using the shortcode:

Get 20% off with code [promocode]SUMMER24[/promocode] — don't miss out!

An optional color attribute overrides the configured button colour:

Grab your [promocode color="#e91e63"]SAVE20[/promocode] before it expires!