Branding Your Help Center
Learn how to customize your help center's branding, logo, and site information
Last updated on March 18, 2024
Branding Your Help Center
Customize your help center's branding to match your company's identity and provide a consistent user experience.
Site Configuration
All branding settings are managed in the lib/config.ts
file. Here's what you can customize:
Site Name and Description
export const siteConfig: SiteConfig = {
siteName: "Your Company Help Center",
siteDescription: "Get help and support for our products",
// ... other settings
};
- siteName: Appears in the header and browser title
- siteDescription: Used for SEO and meta descriptions
Logo Configuration
You can use either a Lucide icon or a custom image for your logo:
Using a Lucide Icon
logo: {
icon: "HelpCircle", // Any Lucide icon name
alt: "Help Center Logo",
}
Popular icon options:
HelpCircle
- Help/support themedBookOpen
- Documentation themedZap
- Modern/tech themedShield
- Security/trust themed
Using a Custom Image
logo: {
icon: "/images/your-logo.png", // Path to your image
alt: "Your Company Logo",
}
Make sure to:
- Place your logo file in the
public/images/
directory - Use appropriate dimensions (recommended: 32x32px or 40x40px)
- Provide descriptive alt text for accessibility
External Links
Configure links to your main website and social profiles:
links: {
website: "https://your-company.com",
changelog: "/changelog",
twitter: "https://twitter.com/yourcompany",
github: "https://github.com/yourcompany/repo",
}
These links appear in the header and footer of your help center.
Best Practices
Logo Guidelines
- Keep logos simple and recognizable at small sizes
- Use SVG format for crisp display on all devices
- Ensure good contrast with both light and dark themes
Naming Conventions
- Use clear, descriptive site names
- Keep descriptions concise but informative
- Maintain consistency with your main brand
Brand Consistency
- Match your main website's color scheme using themes
- Use consistent terminology and voice
- Align with your existing brand guidelines
Examples
Tech Startup
export const siteConfig: SiteConfig = {
siteName: "TechCorp Support",
siteDescription: "Technical documentation and support for TechCorp products",
logo: {
icon: "Zap",
alt: "TechCorp Logo",
},
links: {
website: "https://techcorp.com",
github: "https://github.com/techcorp",
},
};
SaaS Company
export const siteConfig: SiteConfig = {
siteName: "CloudApp Help Center",
siteDescription: "Get the most out of CloudApp with our comprehensive guides",
logo: {
icon: "/images/cloudapp-logo.svg",
alt: "CloudApp Logo",
},
links: {
website: "https://cloudapp.com",
changelog: "/changelog",
twitter: "https://twitter.com/cloudapp",
},
};
Next Steps
After updating your branding configuration:
- Test your changes - Run the development server to see your updates
- Add custom themes - See the Theming Guide for color customization
- Create a favicon - Replace
app/favicon.ico
with your company favicon - Update meta tags - Consider adding Open Graph images for social sharing