Skip to content

Commit aed9be1

Browse files
Copilotneilime
andcommitted
Enforce strict no-customization policy and add local theme usage
Co-authored-by: neilime <[email protected]>
1 parent 786a19b commit aed9be1

File tree

4 files changed

+95
-349
lines changed

4 files changed

+95
-349
lines changed

docs/content/customization/colors.md

Lines changed: 22 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -2,86 +2,41 @@
22
sidebar_position: 1
33
---
44

5-
# Colors
5+
# Colors - No Customization Allowed
66

7-
The Hoverkraft theme uses the **official Hoverkraft color palette** that cannot be customized to ensure consistent branding.
7+
The Hoverkraft theme enforces **strict branding consistency** and **does not allow any color customization**.
88

9-
## Official Branding Reference
9+
## Official Branding Authority
1010

11-
For complete color specifications, usage guidelines, and design principles, refer to the **[Hoverkraft Branding Repository](https://github.com/hoverkraft-tech/branding)**.
11+
All color specifications are defined and maintained in the **[Hoverkraft Branding Repository](https://github.com/hoverkraft-tech/branding)**.
1212

13-
The branding repository contains:
14-
- Official color palette with hex values
15-
- Color usage guidelines and examples
16-
- Accessibility compliance documentation
17-
- Print and digital specifications
18-
- Brand application examples
13+
## Fixed Color Implementation
1914

20-
## Theme Implementation
15+
The theme automatically applies the official Hoverkraft color palette. **No configuration is required or allowed.**
2116

22-
The theme automatically applies the official Hoverkraft colors:
23-
24-
<div className="color-demo">
25-
<div className="color-swatch color-swatch--primary">
26-
Primary<br/>Hoverkraft Blue
27-
</div>
28-
<div className="color-swatch color-swatch--secondary">
29-
Secondary<br/>Professional Gray
30-
</div>
31-
<div className="color-swatch color-swatch--accent">
32-
Accent<br/>Hoverkraft Orange
33-
</div>
34-
</div>
35-
36-
These colors are **permanently fixed** and are applied automatically when you install the theme.
37-
38-
## Why Fixed Colors?
39-
40-
**Brand Consistency**: Every Hoverkraft documentation site must maintain the same professional appearance and brand recognition as defined in the [Hoverkraft Branding Guidelines](https://github.com/hoverkraft-tech/branding).
41-
42-
**Quality Standards**: The colors have been carefully selected and documented in the branding repository for:
43-
- Accessibility compliance (WCAG guidelines)
44-
- Optimal contrast ratios for readability
45-
- Professional appearance across all contexts
46-
- Print-friendly output
47-
48-
**Reduced Complexity**: With fixed colors, there are no configuration decisions to make and no ways for color choices to break the design.
49-
50-
## CSS Implementation
17+
:::warning No Customization
18+
**Colors cannot be customized, overridden, or modified in any way.** This ensures consistent brand identity across all Hoverkraft documentation projects.
19+
:::
5120

52-
The theme uses CSS custom properties internally for consistency:
21+
## Why No Customization?
5322

54-
```css
55-
/* These are set automatically by the theme - do not override */
56-
:root {
57-
--hk-color-primary: /* Official Hoverkraft Blue */;
58-
--hk-color-secondary: /* Official Professional Gray */;
59-
--hk-color-accent: /* Official Hoverkraft Orange */;
60-
--hk-color-dark: /* Official Dark Color */;
61-
--hk-color-light: /* Official Light Color */;
62-
}
63-
```
23+
**Brand Consistency**: Every Hoverkraft documentation site must maintain identical visual branding as specified in the [Hoverkraft Branding Repository](https://github.com/hoverkraft-tech/branding).
6424

65-
:::warning
66-
**Do not attempt to override these values.** The theme is designed to enforce the exact colors specified in the [Hoverkraft Branding Guidelines](https://github.com/hoverkraft-tech/branding).
67-
:::
25+
**Reduced Complexity**: No configuration decisions are needed. Simply install the theme and the correct colors are applied automatically.
6826

69-
## Accessibility & Standards
27+
**Quality Assurance**: Fixed colors prevent any possibility of breaking brand standards or accessibility requirements.
7028

71-
All color combinations meet accessibility standards as documented in the [Hoverkraft Branding Repository](https://github.com/hoverkraft-tech/branding):
29+
## Colors Applied Automatically
7230

73-
- **WCAG AA Compliance**: All text/background combinations meet accessibility standards
74-
- **Color-Blind Friendly**: Colors are distinguishable for users with color vision deficiencies
75-
- **High Contrast**: Text remains readable in all contexts
76-
- **Print-Friendly**: Colors work well in print and grayscale
31+
The theme applies the official Hoverkraft color palette without any configuration:
7732

78-
## Migration from Customizable Versions
33+
- **Primary Color**: Official Hoverkraft blue
34+
- **Secondary Color**: Professional gray
35+
- **Accent Color**: Hoverkraft orange
36+
- **Supporting Colors**: As defined in the branding repository
7937

80-
If you previously used a version that allowed color customization:
38+
All colors meet accessibility standards and are optimized for both digital and print contexts.
8139

82-
1. **Remove color overrides** from your configuration
83-
2. **Refer to the branding repository** for official color specifications
84-
3. **Update your custom CSS** to work with the fixed palette
85-
4. **Test your content** to ensure it works with the enforced colors
40+
## For Complete Specifications
8641

87-
The fixed color palette ensures your documentation automatically follows the [Hoverkraft Branding Guidelines](https://github.com/hoverkraft-tech/branding).
42+
For detailed color values, usage guidelines, and brand compliance information, refer to the **[Hoverkraft Branding Repository](https://github.com/hoverkraft-tech/branding)**.

0 commit comments

Comments
 (0)