User Guide
Basic Configuration
Application name, Logo, theme system and internationalization configuration
This document covers basic configuration options for TinyShip, including application name, Logo, theme system, and internationalization.
Application Basic Configuration
Application Name
The application name appears in page titles, next to the Logo, in email templates, etc.
// config.ts
export const config = {
app: {
name: 'TinyShip', // Change to your app name
}
}Logo Configuration
TinyShip supports flexible Logo configuration:
// config.ts
export const config = {
app: {
logo: {
iconUrl: '/logo.svg',
fullLogoUrl: undefined,
iconClassName: 'bg-chart-1 rounded-full p-2',
},
}
}| Option | Description | Example |
|---|---|---|
iconUrl | Logo icon path | /logo.svg |
fullLogoUrl | Full logo image path (optional) | /full-logo.png |
iconClassName | Icon container CSS classes | bg-chart-1 rounded-full p-2 |
Theme System Configuration
TinyShip includes 5 beautiful color schemes:
- Default Theme: Classic grayscale palette
- Claude Theme: Warm orange palette
- Cosmic Night Theme: Mysterious purple palette
- Modern Minimal Theme: Modern minimal purple-blue palette
- Ocean Breeze Theme: Fresh teal palette
Configure Theme
// config.ts
export const config = {
app: {
theme: {
defaultTheme: 'light' as const,
defaultColorScheme: 'claude' as const,
storageKey: 'tinyship-ui-theme'
}
}
}Create Custom Theme
- Visit tweakcn.com theme editor
- Customize colors with the visual editor
- Export theme CSS
- Create a new theme file in
libs/ui/styles/themes/
Internationalization Configuration
TinyShip provides comprehensive internationalization support:
- English (en) - English
- 简体中文 (zh-CN) - Simplified Chinese, default language
Configure Language
// config.ts
export const config = {
app: {
i18n: {
defaultLocale: 'zh-CN' as const,
locales: ['en', 'zh-CN'] as const,
cookieKey: 'NEXT_LOCALE',
autoDetect: false
}
}
}Add New Translations
- Add English translations in
libs/i18n/locales/en.ts - Add corresponding Chinese translations in
libs/i18n/locales/zh-CN.ts - Restart the development server