Skip to content

Commit 4ad48db

Browse files
committed
docs
1 parent 59ddc19 commit 4ad48db

File tree

1 file changed

+90
-7
lines changed

1 file changed

+90
-7
lines changed

docs/Configuration/Other Customisations.md

Lines changed: 90 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,48 @@ Static files in the application come from the `frontend/public/` folder in the s
3131
2. Match the directory structure in your `customFiles/static/` folder
3232

3333
Common files you might want to override:
34+
35+
**Favicons & Icons:**
3436
- `favicon.svg`, `favicon.ico` - Browser favicons
35-
- `classic-logo/logo.svg` - Classic logo
36-
- `modern-logo/logo.svg` - Modern logo
37-
- `apple-touch-icon.png` - iOS icon
38-
- Images, fonts, and other assets
37+
- `apple-touch-icon.png` - iOS home screen icon
38+
- `android-chrome-192x192.png` - Android icon (192x192)
39+
- `android-chrome-512x512.png` - Android icon (512x512)
40+
41+
**Logo Variants (Both classic-logo/ and modern-logo/):**
42+
43+
Both logo directories contain the same file structure - just replace `classic-logo/` or `modern-logo/` with whichever style you're using:
44+
45+
- `{style}/StirlingPDFLogoBlackText.svg` - Logo with black text (light mode)
46+
- `{style}/StirlingPDFLogoWhiteText.svg` - Logo with white text (dark mode)
47+
- `{style}/StirlingPDFLogoGreyText.svg` - Logo with grey text
48+
- `{style}/StirlingPDFLogoNoTextDark.svg` - Logo without text (dark variant)
49+
- `{style}/StirlingPDFLogoNoTextLight.svg` - Logo without text (light variant)
50+
- `{style}/logo-tooltip.svg` - Small logo for tooltips
51+
- `{style}/favicon.ico` - Style-specific favicon
52+
- `{style}/logo192.png`, `{style}/logo512.png` - PNG versions at different sizes
53+
- `{style}/Firstpage.png` - First page preview image
54+
55+
Where `{style}` is either `classic-logo` or `modern-logo` depending on your logo style setting:
56+
57+
**Settings file (configs/settings.yml):**
58+
```yaml
59+
ui:
60+
logoStyle: classic # Options: 'classic' or 'modern'
61+
```
62+
63+
**Environment variable (Docker):**
64+
```bash
65+
UI_LOGOSTYLE=classic
66+
```
67+
68+
**In-app configuration:**
69+
Settings → UI → Logo Style (requires login enabled)
70+
71+
**Other Assets:**
72+
- `moon.svg` - Dark mode toggle icon
73+
- `robots.txt` - Search engine directives
74+
- `manifest.json`, `manifest-classic.json` - Web app manifests
75+
- Images, fonts, and locales
3976

4077
### Example: Custom Favicon
4178

@@ -55,16 +92,62 @@ volumes:
5592
5693
Restart the container - your custom favicons will be used!
5794
58-
### Example: Custom Logo
95+
### Example: Custom Logo (Simple)
5996
6097
```bash
6198
customFiles/
6299
└── static/
63100
└── classic-logo/
64-
└── logo.svg
101+
└── StirlingPDFLogoBlackText.svg
102+
```
103+
104+
This overrides the classic logo with black text (used in light mode).
105+
106+
**Important:** Make sure your logo style is set to `classic` in your configuration:
107+
```yaml
108+
ui:
109+
logoStyle: classic # Must match the directory you're overriding!
110+
```
111+
112+
Or via environment variable:
113+
```bash
114+
UI_LOGOSTYLE=classic
115+
```
116+
117+
If you have `logoStyle: modern` set, override files in `modern-logo/` instead!
118+
119+
### Example: Complete Branding Customization
120+
121+
To fully rebrand Stirling-PDF with your company logo, override multiple variants:
122+
123+
```bash
124+
customFiles/
125+
└── static/
126+
├── favicon.svg # Main favicon
127+
├── favicon.ico # Legacy favicon
128+
└── classic-logo/ # Or modern-logo/ if using modern style
129+
├── StirlingPDFLogoBlackText.svg # Light mode with text
130+
├── StirlingPDFLogoWhiteText.svg # Dark mode with text
131+
├── StirlingPDFLogoNoTextLight.svg # Light mode icon only
132+
├── StirlingPDFLogoNoTextDark.svg # Dark mode icon only
133+
├── logo-tooltip.svg # Small icon
134+
├── favicon.ico # Style-specific favicon
135+
└── Firstpage.png # Homepage preview
65136
```
66137

67-
This overrides the classic Stirling-PDF logo.
138+
**Important:** Set your logo style to match the directory:
139+
```yaml
140+
ui:
141+
logoStyle: classic # Use 'classic' if overriding classic-logo/, 'modern' if overriding modern-logo/
142+
```
143+
144+
Or via environment variable: `UI_LOGOSTYLE=classic`
145+
146+
**Tips:**
147+
- For consistent branding across light/dark modes, provide both:
148+
- `StirlingPDFLogoBlackText.svg` (shows on light backgrounds)
149+
- `StirlingPDFLogoWhiteText.svg` (shows on dark backgrounds)
150+
- You can also configure this in-app: Settings → UI → Logo Style (if you have login enabled)
68151

69152
### Advanced: Overriding Built Files (HTML, JS, CSS)
70153

0 commit comments

Comments
 (0)