Merge branch 'feature/custom-bootstrap-styling'

2025-10-27 22:05:07 +01:00
parent 7a9b4ccd54 bf52fda68f
commit a72c98fe00
8 changed files with 361 additions and 0 deletions
@@ -0,0 +1,14 @@
+// Custom Component Styles
+// Add custom styles that extend or modify Bootstrap components
+
+// Example: Custom navbar styling
+// .navbar-brand {
+//   font-weight: 700;
+// }
+
+// Example: Custom card styling
+// .card {
+//   border-radius: 8px;
+// }
+
+// Add your custom styles here
@@ -0,0 +1,57 @@
+// Bootstrap Variable Overrides
+// These variables override Bootstrap's default design tokens
+// They are applied via CSS custom properties and utility classes
+
+// Typography - Base Font Size
+// This is the root font size that Bootstrap uses for all rem calculations
+// Default: 1rem (typically 16px in browsers)
+$font-size-base: 1.25rem;
+
+// You can also set it to a specific pixel value:
+// $font-size-base: 18px;  // Makes everything slightly larger
+
+body {
+  font-size: $font-size-base;
+}
+
+// Typography - Heading Font Sizes
+// Customize heading sizes to establish visual hierarchy
+$h1-font-size: 2rem;   // Default: 2.5rem
+$h2-font-size: 1.75rem;     // Default: 2rem
+$h3-font-size: 1.5rem;  // Default: 1.75rem
+$h4-font-size: 1.25rem;   // Default: 1.5rem
+$h5-font-size: 1rem;  // Default: 1.25rem
+$h6-font-size: 1rem;     // Default: 1rem
+
+// Apply heading sizes using CSS
+h1 { font-size: $h1-font-size; }
+h2 { font-size: $h2-font-size; }
+h3 { font-size: $h3-font-size; }
+h4 { font-size: $h4-font-size; }
+h5 { font-size: $h5-font-size; }
+h6 { font-size: $h6-font-size; }
+
+// Link Colors
+// Customize link colors for brand consistency
+$link-color: #0b0089;           // Default Bootstrap: #0d6efd
+$link-hover-color: #0052a3;     // Darker shade for hover state
+
+a {
+  color: $link-color;
+
+  &:hover {
+    color: $link-hover-color;
+  }
+}
+
+// Spacing
+// Uncomment and customize spacing scale if needed
+// $spacer: 1rem;
+// $spacers: (
+//   0: 0,
+//   1: $spacer * 0.25,
+//   2: $spacer * 0.5,
+//   3: $spacer,
+//   4: $spacer * 1.5,
+//   5: $spacer * 3,
+// );
@@ -0,0 +1,8 @@
+// Main SCSS entry point for custom Bootstrap styling
+// This file is processed by Hugo Pipes and loaded after Bootstrap CDN CSS
+
+// Import Bootstrap variable overrides
+@import 'variables';
+
+// Import custom component styles
+@import 'custom';
@@ -0,0 +1,163 @@
+# Custom SCSS Styling
+
+This document describes the SCSS-based custom styling system for the markusgraf.ch Hugo site.
+
+## Overview
+
+The site uses a hybrid approach for styling:
+- **Bootstrap 5.3.2** loaded from CDN (core framework)
+- **Custom SCSS** compiled via Hugo Pipes (overrides and custom styles)
+
+This approach provides the benefits of Bootstrap's CDN (speed, caching) while allowing complete customization through SCSS.
+
+## File Structure
+
+```
+assets/scss/
+├── main.scss          # Main entry point (imports all partials)
+├── _variables.scss    # Bootstrap variable overrides
+└── _custom.scss       # Custom component styles
+```
+
+### main.scss
+The main entry point that Hugo processes. This file imports all SCSS partials in the correct order.
+
+### _variables.scss
+Bootstrap variable overrides for customizing design tokens:
+- Heading font sizes (h1-h6)
+- Link colors and hover states
+- Spacing scale (optional)
+- Any other Bootstrap variables
+
+### _custom.scss
+Custom component styles and utilities that extend Bootstrap or add new styles.
+
+## How It Works
+
+### Compilation Process
+
+1. Hugo reads `assets/scss/main.scss`
+2. Hugo processes SCSS with `css.Sass` function
+3. Output is minified (`outputStyle: compressed`)
+4. CSS is fingerprinted with SHA-384 for cache busting
+5. Integrity hash is added to the `<link>` tag
+
+### CSS Load Order
+
+In `layouts/_default/baseof.html`:
+
+```html
+<!-- Bootstrap CDN CSS (base styles) -->
+<link href="https://cdn.jsdelivr.net/.../bootstrap.min.css" rel="stylesheet">
+
+<!-- Custom compiled CSS (overrides) -->
+<link rel="stylesheet" href="/css/main.[fingerprint].css" integrity="sha384-...">
+```
+
+This order ensures custom styles cascade over Bootstrap defaults.
+
+## Customization Guide
+
+### Changing Heading Sizes
+
+Edit `assets/scss/_variables.scss`:
+
+```scss
+$h1-font-size: 3rem;     // Make h1 larger
+$h2-font-size: 2.25rem;  // Make h2 larger
+```
+
+### Changing Link Colors
+
+Edit `assets/scss/_variables.scss`:
+
+```scss
+$link-color: #0066cc;        // Primary link color
+$link-hover-color: #0052a3;  // Hover state color
+```
+
+### Adding Custom Component Styles
+
+Edit `assets/scss/_custom.scss`:
+
+```scss
+.navbar-brand {
+  font-weight: 700;
+  letter-spacing: 0.05em;
+}
+
+.card {
+  border-radius: 8px;
+  box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+}
+```
+
+### Adding New SCSS Partials
+
+1. Create a new file: `assets/scss/_mypartial.scss`
+2. Import it in `main.scss`: `@import 'mypartial';`
+
+## Development Workflow
+
+### Development Mode
+
+```bash
+hugo server
+```
+
+- SCSS changes trigger automatic recompilation
+- Browser live-reloads with updated styles
+- Source maps are available for debugging
+
+### Production Build
+
+```bash
+hugo build
+```
+
+- SCSS is compiled with minification
+- No source maps are included
+- CSS is fingerprinted for cache busting
+
+## Performance
+
+- Custom CSS file size: ~154 bytes (current)
+- Minified and compressed
+- Cached via fingerprinting
+- Minimal impact on page load
+
+## Best Practices
+
+1. **Keep it minimal** - Only override what you need
+2. **Use SCSS features** - Variables, nesting, mixins when beneficial
+3. **Organize by concern** - Use partials to separate different types of styles
+4. **Comment your code** - Explain why specific overrides are needed
+5. **Test in multiple browsers** - Ensure compatibility
+
+## Troubleshooting
+
+### SCSS Won't Compile
+
+Check Hugo version supports `css.Sass` (v0.128.0+):
+```bash
+hugo version
+```
+
+### Styles Not Applying
+
+1. Check CSS load order in browser DevTools
+2. Verify fingerprinted CSS file exists in `public/css/`
+3. Check for SCSS syntax errors in Hugo output
+
+### Cache Issues
+
+The fingerprinting ensures cache busting, but during development you can:
+```bash
+hugo server --disableFastRender
+```
+
+## References
+
+- [Hugo Pipes SCSS Processing](https://gohugo.io/hugo-pipes/scss-sass/)
+- [Bootstrap 5.3 Customization](https://getbootstrap.com/docs/5.3/customize/sass/)
+- [SCSS Documentation](https://sass-lang.com/documentation)
@@ -9,6 +9,12 @@
  <!-- Bootstrap 5.x CSS -->
  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-T3c6CoIi6uLrA9TneNEoa7RxnatzjcDSCmG1MXxSR1GAsXEV/Dwwykc2MPK8M2HN" crossorigin="anonymous">

+  <!-- Custom SCSS compiled via Hugo Pipes -->
+  {{ $scss := resources.Get "scss/main.scss" }}
+  {{ $options := dict "targetPath" "css/main.css" "outputStyle" "compressed" }}
+  {{ $style := $scss | css.Sass $options | resources.Fingerprint "sha384" }}
+  <link rel="stylesheet" href="{{ $style.Permalink }}" integrity="{{ $style.Data.Integrity }}" crossorigin="anonymous">
+
  {{ block "head" . }}{{ end }}
 </head>
 <body>
@@ -0,0 +1,18 @@
+## Why
+The site currently uses Bootstrap 5.3.2 from CDN with default styling. To establish a unique visual identity and brand consistency, we need the ability to customize Bootstrap variables (font sizes, colors, spacing) and add custom styles without modifying the core framework.
+
+## What Changes
+- Add Hugo SCSS/SASS processing pipeline using Hugo Pipes
+- Create custom SCSS file structure for Bootstrap variable overrides and custom styles
+- Maintain Bootstrap CSS from CDN for core framework
+- Compile custom styles to supplement Bootstrap defaults
+- Enable customization of heading font sizes, link colors, and other design tokens
+
+## Impact
+- Affected specs: `styling` (new capability)
+- Affected code:
+  - `layouts/_default/baseof.html` - Update to include compiled custom CSS
+  - `assets/scss/` - New directory for SCSS files
+  - `hugo.toml` - May need configuration for SCSS processing
+- No breaking changes to existing functionality
+- Performance: Minimal impact, adds one additional CSS file (~few KB)
@@ -0,0 +1,65 @@
+## ADDED Requirements
+
+### Requirement: SCSS Processing Pipeline
+The system SHALL process SCSS files using Hugo Pipes to generate custom CSS that supplements Bootstrap's CDN-provided styles.
+
+#### Scenario: SCSS compilation on build
+- **WHEN** Hugo builds the site
+- **THEN** SCSS files in `assets/scss/` are compiled to CSS
+- **AND** the compiled CSS is fingerprinted for cache busting
+- **AND** the resulting CSS file is included in the HTML output
+
+#### Scenario: Development mode with live reload
+- **WHEN** running Hugo in development mode (hugo server)
+- **THEN** SCSS changes trigger automatic recompilation
+- **AND** the browser live-reloads with updated styles
+
+### Requirement: Bootstrap Variable Customization
+The system SHALL allow customization of Bootstrap design tokens through SCSS variables without modifying the CDN-provided Bootstrap CSS.
+
+#### Scenario: Override heading font sizes
+- **WHEN** custom heading sizes are defined in SCSS variables
+- **THEN** the compiled CSS applies these sizes to heading elements
+- **AND** the Bootstrap CDN CSS is loaded first (base styles)
+- **AND** custom CSS is loaded after (overrides)
+
+#### Scenario: Override link colors
+- **WHEN** custom link colors are defined in SCSS variables
+- **THEN** links across the site use the custom colors
+- **AND** link hover states use appropriate custom colors
+
+#### Scenario: Override spacing scale
+- **WHEN** custom spacing values are defined
+- **THEN** elements using those spacing classes reflect the custom values
+
+### Requirement: Custom Style Organization
+The system SHALL organize custom styles in a maintainable SCSS file structure following Hugo and SASS best practices.
+
+#### Scenario: Main SCSS entry point
+- **WHEN** Hugo processes SCSS
+- **THEN** a single main SCSS file serves as the entry point
+- **AND** this file imports Bootstrap variable overrides
+- **AND** this file imports custom component styles
+- **AND** this file imports custom utility styles
+
+#### Scenario: Modular SCSS files
+- **WHEN** developers add new custom styles
+- **THEN** styles can be organized into separate partial files
+- **AND** partial files are imported into the main SCSS file
+- **AND** file naming follows SCSS conventions (e.g., `_variables.scss`, `_custom.scss`)
+
+### Requirement: CSS Output Integration
+The system SHALL integrate compiled custom CSS into the base layout template alongside Bootstrap CDN CSS.
+
+#### Scenario: CSS load order
+- **WHEN** a page is rendered
+- **THEN** Bootstrap CDN CSS loads first
+- **AND** custom compiled CSS loads second
+- **AND** CSS files include integrity hashes where applicable
+- **AND** the custom CSS file path includes a fingerprint for cache busting
+
+#### Scenario: Production build optimization
+- **WHEN** building for production
+- **THEN** SCSS is compiled with minification
+- **AND** the output CSS is optimized for file size
+- **AND** source maps are not included in production builds
@@ -0,0 +1,30 @@
+## 1. SCSS Infrastructure Setup
+- [x] 1.1 Create `assets/scss/` directory structure
+- [x] 1.2 Create main SCSS entry file `assets/scss/main.scss`
+- [x] 1.3 Create Bootstrap variable overrides file `assets/scss/_variables.scss`
+- [x] 1.4 Create custom styles file `assets/scss/_custom.scss`
+
+## 2. Hugo Pipes Integration
+- [x] 2.1 Update `layouts/_default/baseof.html` to process SCSS with Hugo Pipes
+- [x] 2.2 Configure SCSS compilation with `css.Sass` (updated from deprecated `resources.ToCSS`)
+- [x] 2.3 Add fingerprinting for cache busting with `resources.Fingerprint`
+- [x] 2.4 Ensure correct CSS load order (Bootstrap CDN first, then custom)
+
+## 3. Initial Custom Styles
+- [x] 3.1 Add heading font size customizations to `_variables.scss`
+- [x] 3.2 Add link color customizations to `_variables.scss`
+- [x] 3.3 Test variable overrides render correctly
+- [x] 3.4 Verify styles cascade properly over Bootstrap defaults
+
+## 4. Testing & Validation
+- [x] 4.1 Test SCSS compilation in development mode (hugo server)
+- [x] 4.2 Test production build (hugo build)
+- [x] 4.3 Verify live reload works with SCSS changes
+- [x] 4.4 Check generated CSS file size and performance (154 bytes minified)
+- [x] 4.5 Validate CSS output is minified in production
+- [x] 4.6 Test in multiple browsers for consistency
+
+## 5. Documentation
+- [x] 5.1 Document SCSS file structure and conventions
+- [x] 5.2 Add examples of how to customize Bootstrap variables
+- [x] 5.3 Document the CSS compilation and caching strategy