Badge Configuration and Settings

Configure your badge settings including type, style, attribution, and link destinations.

All Articles

Badge Configuration and Settings

Configure your ChangeCrab badge settings including type, style, attribution, and link destinations to match your needs and brand.

Accessing Badge Settings

  1. Log in to your ChangeCrab account
  2. Navigate to your changelog settings
  3. Click on the "Badges" section in the settings menu
  4. You'll see your current badge configuration and a live preview

Configuration Options

Badge Type

Choose what information your badge displays:

  • Update Frequency - Shows how often you update (e.g., "Updated Weekly")
  • Tier Level - Displays your current tier (Bronze, Silver, Gold, Inactive)
  • Basic Activity Indicator - Simple active/inactive status

All badge types are available to all users. The type you choose becomes the default for all your embed codes.

Badge Style

Control the visual appearance of your badge:

  • Flat - Available to all users. Clean, modern design with rounded corners.
  • Plastic - Paid users only. 3D plastic effect with enhanced gradients.
  • Flat Square - Paid users only. Flat design with square corners.
  • Flat Dark - Paid users only. Dark theme variant.
  • Plastic Dark - Paid users only. Dark theme with plastic effect.
  • Flat Square Dark - Paid users only. Dark theme with square corners.

Free users can use the "Flat" style. Paid subscribers have access to all style options.

Show Attribution

Control whether the "ChangeCrab" text appears next to the logo:

  • Shown - Displays "ChangeCrab" text (required for free users)
  • Hidden - Shows only the logo (paid users only)

Free users must show attribution. Paid users can hide it for a cleaner, more minimal badge appearance.

Badge Area Link

Configure where the badge text area (right side) links to:

  • Default - Links to your changelog homepage
  • Custom URL - Set any URL you want (e.g., your product page, documentation, etc.)

Note: The left side (logo and "ChangeCrab" text) always links to ChangeCrab.com and cannot be changed.

Live Preview

The badge settings page includes a live preview that shows exactly how your badge will appear:

  • Updates in real-time as you change settings
  • Shows your current tier and color
  • Displays the exact badge that will be embedded
  • Helps you choose the right combination

Tier Information

The badge settings page also displays:

  • Current Tier - Your tier level (Bronze, Silver, Gold, or Inactive)
  • Tier Color - The color badge that matches your tier
  • Weeks Active - How many distinct weeks you've updated in the last 60 days
  • Last Updated - When you last published a changelog entry
  • Progress to Next Tier - What you need to reach the next tier level
  • Week Timeline - Visual representation of which weeks have updates

Embed Codes

Once configured, the settings page provides multiple embed code options:

  • Script Embed - Recommended. JavaScript-based, updates automatically.
  • Markdown - For README files and Markdown documentation.
  • HTML (Image/SVG) - Simple image embed for HTML pages.
  • Direct URL - Direct badge URL for use in <img> tags.

All embed codes reflect your current configuration settings.

Saving Settings

  1. Configure your badge type, style, and other options
  2. Review the live preview to ensure it looks correct
  3. Click "Save Settings"
  4. Your settings are saved and all embed codes update automatically

Note: Badge caches are automatically cleared when you save settings, so changes appear immediately.

Free vs Paid Features

Free Users

  • Can use all badge types (frequency, tier, activity)
  • Can use "Flat" style only
  • Must show "ChangeCrab" attribution
  • Full access to tier information and progress

Paid Users

  • Can use all badge types
  • Can use all badge styles (flat, plastic, square, dark themes)
  • Can hide "ChangeCrab" attribution for minimal badges
  • Full access to tier information and progress

Best Practices

  • Match Your Brand - Choose a style that matches your website's design
  • Consider Context - Frequency type for update cadence, Tier type for achievement display
  • Test Different Options - Use the live preview to see how different combinations look
  • Update Regularly - Keep your changelog updated to maintain or improve your tier
  • Link Strategically - Set the badge link to drive traffic where you want it

Changing Settings

You can change your badge settings at any time:

  1. Go to badge settings
  2. Modify any option
  3. Save your changes
  4. Update your embed codes if needed (script embeds update automatically)

Note: If you're using HTML or Markdown embeds, you may need to update them manually. Script embeds update automatically.

Troubleshooting

Settings Not Saving

  • Ensure you're logged in
  • Check that you have permission to edit the changelog
  • Try refreshing the page and saving again

Preview Not Updating

  • Wait a moment for the preview to refresh
  • Try changing a setting and changing it back
  • Refresh the page if needed

Style Options Not Available

  • Some styles are only available to paid users
  • Check your subscription status
  • Upgrade to access all style options

Next Steps