Skip to main content

Settings Guide

A complete reference for the rebrand/settings.md configuration file.

Overview​

The rebrand/settings.md file is the single source of truth (SSOT) for all rebranding decisions. It uses a simple Markdown format that is easy to read and edit.

Core Information​

This section defines the basic identity of your application.

  • App Name: The name of your application (e.g., "MyDash"). Replaces "LibreApps Desktop" throughout the codebase.
  • Company Name: Your company's name. Replaces "LibreApps" in footers and legal text.
  • Website URL: The primary URL for your brand.
  • Primary Color: (Optional) A hex or HSL color to override the theme's primary color.
  • Template Kit: Choose between Full-Kit (feature-rich) or Starter-Kit (minimal).

Dashboard Layout​

Configure the visual style and behavior of the dashboard.

  • Layout Type: Sidebar, Horizontal, or Stacked.
  • Theme Mode: light, dark, or system.
  • Theme Name: The name of the theme to apply (e.g., LibreApps, Candy, Core, Viva, or default). The default high-vibrancy theme is LibreApps.
  • Shadcn Theme URL: (Optional) A URL from ShadcnThemer to fetch a custom theme.
  • Radius: The border radius for UI components (e.g., 0.5).

Navigation & Pages​

Control which sections and pages are included in your build. Use [x] to enable and [ ] to disable.

Section: Dashboards​

  • Analytics: Enable/disable the analytics dashboard.
  • CRM: Enable/disable the CRM dashboard.
  • eCommerce: Enable/disable the eCommerce dashboard.

Section: Applications​

  • Email: Enable/disable the email app.
  • Chat: Enable/disable the chat app.
  • Calendar: Enable/disable the calendar app.
  • Kanban: Enable/disable the Kanban board.

Widget Toggling​

Fine-tune the components visible on each dashboard page.

  • Revenue Card: Toggle the revenue summary widget.
  • Sales Chart: Toggle the main sales performance chart.
  • Recent Activity: Toggle the activity feed.

Best Practices​

  • ✅ Do this: Keep the Markdown formatting consistent to ensure the rebrand engine parses it correctly.
  • ✅ Do this: Use descriptive names for your custom themes.
  • ❌ Don't do this: Remove required fields like App Name or Theme Name; they are essential for the build process.