{% extends "var_cms/base.html" %} {% load var_cms_tags %} {% block title %}Help & Support{% endblock %} {% block extra_head %} {% endblock %} {% block content %}
{{ readme_html|safe_html }}

Live Color Customizer

Pick a primary accent brand color using the picker below to dynamically generate HSL values and see a live preview.

Brand Color
#7A5CFF
Generated Settings Variable var_cms_site.accent_color = "250, 100%, 68%"

Integration Guide

Integrate VAR CMS into your Django application and customize its branding options within your admin registrations. 

# myapp/var_cms_admin.py
from var_cms.registry import var_cms_site, VarCMSModelAdmin
from .models import Article

# 1. Custom Branding Settings
var_cms_site.site_header = "My Site Header"
var_cms_site.site_sub    = "Control Dashboard"
var_cms_site.site_url    = "/"
var_cms_site.logo_url    = "/static/logo.png"

# 2. Custom Color Palette (Paste generated code)
var_cms_site.accent_color = "250, 100%, 68%"

# 3. Custom User Model Username Field Configuration
var_cms_site.username_field = "email"  # Defaults to auto-detecting USERNAME_FIELD

# 4. Global Dashboard Card Filters
var_cms_site.hidden_dashboard_cards = ["demo.category", "mediaasset"] # Hide globally

# 5. Custom Model Configurations
class ArticleAdmin(VarCMSModelAdmin):
    icon = "file-text"
    html_fields = ["body"]
    dashboard_card = True  # Set to False to hide this specific card locally
    
    # Simple presets for layout widths (full, half, one-third, two-thirds, etc.)
    form_field_widths = {
        "title": "two-thirds",
        "status": "one-third",
    }
    
    # Custom widget placeholders & help texts
    form_field_placeholders = {
        "title": "Enter article title...",
    }
    form_field_help_texts = {
        "body": "Write the article body here.",
    }
    
    # Custom regular expression validation
    regex_validators = {
        "slug": (r"^[a-z0-9-]+$", "Slug must consist of lowercase letters, numbers, and hyphens only.")
    }
    
    # Custom quick navigation buttons on dashboard card
    card_buttons = [
        {"label": "All Articles", "action": "list"},
        {"label": "Write Draft", "action": "add"},
        {"label": "Docs Link", "url": "https://example.com", "class": "btn-ghost"}
    ]

var_cms_site.register(Article, ArticleAdmin)
{% if var_cms_site.developer_name %}

{{ var_cms_site.developer_name }}

Lead Developer

Thank you for using VAR CMS. This dashboard is powered by a premium admin panel structure, optimized with HSL styles, collapsible navigation layouts, and searchable input dropdown controls.

{% if var_cms_site.developer_website %} Website {% endif %} {% if var_cms_site.developer_github %} GitHub {% endif %} {% if var_cms_site.developer_linkedin %} LinkedIn {% endif %} {% if var_cms_site.developer_email %} Send Email {% endif %}
{% else %}

Configure Developer Settings

You can configure the developer's name and social contact coordinates directly in your configuration registry. 

# var_cms_admin.py
var_cms_site.developer_name = "Rahul Prajapat"
var_cms_site.developer_website = "https://rahul.dev"
var_cms_site.developer_github = "https://github.com"
var_cms_site.developer_linkedin = "https://linkedin.com"
var_cms_site.developer_email = "mail@example.com"
{% endif %}
{% endblock %}