Bovine Website

A documentation website built with Hugo and the Docsy theme.

Prerequisites

• Hugo Extended v0.110.0 or later
• Node.js v22 or later
• npm
• Go (for Hugo modules)

Development

Initial Setup

Install dependencies:

npm install
hugo mod tidy

Local Development

Start the development server:

npm run serve
# or
hugo server -D

The site will be available at http://localhost:1313

Building

Build the site for production:

# Standard build with minification
npm run build

# Production build with garbage collection and clean destination
npm run build:production

Manual Build Commands

If you prefer to run Hugo directly:

# Basic build (no optimizations)
hugo

# Build with minification (recommended)
hugo --minify

# Production build with all optimizations
hugo --minify --gc --cleanDestinationDir

Build flags explained:

• --minify: Minifies HTML, CSS, JS, JSON, SVG, and XML files
• --gc: Runs garbage collection after build to clean up unused cache files
• --cleanDestinationDir: Removes files from destination not found in static or generated

The built site will be in the public/ directory.

Project Structure

bovine-website/
├── content/en/         # English content
│   ├── docs/          # Documentation pages
│   ├── blog/          # Blog posts
│   └── _index.md      # Homepage
├── hugo.toml          # Hugo configuration
├── package.json       # Node.js dependencies
└── go.mod            # Hugo module dependencies

Adding Content

Documentation

Create new documentation pages in content/en/docs/:

hugo new content/en/docs/your-page.md

Blog Posts

Create new blog posts in content/en/blog/:

hugo new content/en/blog/your-post.md

Configuration

Main configuration is in hugo.toml. Key settings:

• baseURL: The site's base URL
• title: Site title
• params: Docsy theme parameters

Performance Optimizations

This site includes several performance optimizations:

Asset Optimization

• WebP Images: Hero background converted from JPG to WebP (85% size reduction: 645KB → 96KB)
• Font Loading: Google Fonts loaded with preconnect for faster initial connection
• Minification: Automatic minification of HTML, CSS, JS, JSON, SVG, and XML in production builds

Hugo Configuration

• Minification enabled via hugo.toml [minify] section
• Image quality optimized at 75% with CatmullRom resampling
• Smart anchor positioning for responsive images

Build Process

• Standard build includes --minify flag
• Production build adds --gc and --cleanDestinationDir for optimal output

Repository

• Repository: https://code.squarecows.com/SquareCows/pages-server
• Organization: SquareCows

License

Copyright SquareCows