--- name: hugo description: | This skill provides comprehensive knowledge for building static websites with Hugo static site generator. It should be used when setting up Hugo projects (blogs, documentation sites, landing pages, portfolios), integrating Tailwind CSS v4 for custom styling, integrating headless CMS systems (Sveltia CMS or TinaCMS), deploying to Cloudflare Workers with Static Assets, configuring themes and templates, and preventing common Hugo setup errors. Use this skill when encountering these scenarios: scaffolding new Hugo sites, choosing between Hugo Extended and Standard editions, integrating Tailwind CSS v4 with Hugo Pipes, configuring hugo.yaml or hugo.toml files, integrating PaperMod or other themes via Git submodules, setting up Sveltia CMS or TinaCMS for content management, deploying to Cloudflare Workers or Pages, troubleshooting baseURL configuration, resolving theme installation errors, fixing frontmatter format issues (YAML vs TOML), preventing date-related build failures, setting up PostCSS with Hugo, or setting up CI/CD with GitHub Actions. Keywords: hugo, hugo-extended, static-site-generator, ssg, go-templates, papermod, goldmark, markdown, blog, documentation, docs-site, landing-page, sveltia-cms, tina-cms, headless-cms, cloudflare-workers, workers-static-assets, wrangler, hugo-server, hugo-build, frontmatter, yaml-frontmatter, toml-config, hugo-themes, hugo-modules, multilingual, i18n, github-actions, version-mismatch, baseurl-error, theme-not-found, tailwind, tailwind-v4, tailwind-css, hugo-pipes, postcss, css-framework, utility-css, hugo-tailwind, tailwind-integration, hugo-assets license: MIT metadata: version: "2.0.0" hugo_version: "0.152.2" tailwind_version: "4.1.16" last_verified: "2025-11-04" production_tested: true token_savings: "60-65%" errors_prevented: 15 templates_included: 6 --- # Hugo Static Site Generator **Status**: Production Ready **Last Updated**: 2025-11-04 **Dependencies**: None (Hugo is a standalone binary) **Latest Versions**: hugo@0.152.2+extended, PaperMod@latest, Sveltia CMS@latest --- ## Quick Start (5 Minutes) ### 1. Install Hugo Extended **CRITICAL**: Always install Hugo **Extended** edition (not Standard) unless you're certain you don't need SCSS/Sass support. Most themes require Extended. ```bash # macOS brew install hugo # Linux (Ubuntu/Debian) wget https://github.com/gohugoio/hugo/releases/download/v0.152.2/hugo_extended_0.152.2_linux-amd64.deb sudo dpkg -i hugo_extended_0.152.2_linux-amd64.deb # Verify Extended edition hugo version # Should show "+extended" ``` **Why this matters:** - Hugo Extended includes SCSS/Sass processing - Most popular themes (PaperMod, Academic, Docsy) require Extended - Standard edition will fail with "SCSS support not enabled" errors - Extended has no downsides (same speed, same features + more) ### 2. Create New Hugo Site ```bash # Use YAML format (not TOML) for better CMS compatibility hugo new site my-blog --format yaml # Initialize Git cd my-blog git init # Add PaperMod theme (recommended for blogs) git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod ``` **CRITICAL:** - Use `--format yaml` to create hugo.yaml (not hugo.toml) - YAML is required for Sveltia CMS and recommended for TinaCMS - TOML has known bugs in Sveltia CMS beta - Git submodules require `--recursive` flag when cloning later ### 3. Configure and Build ```yaml # hugo.yaml - Minimal working configuration baseURL: "https://example.com/" title: "My Hugo Blog" theme: "PaperMod" languageCode: "en-us" enableRobotsTXT: true params: ShowReadingTime: true ShowShareButtons: true defaultTheme: auto # Supports dark/light/auto ``` ```bash # Create first post hugo new content posts/first-post.md # Run development server (with live reload) hugo server # Build for production hugo --minify # Output is in public/ directory ``` --- ## The 7-Step Setup Process ### Step 1: Installation and Verification **Install Hugo Extended** using one of these methods: **Method 1: Homebrew (macOS/Linux)** ✅ Recommended ```bash brew install hugo ``` **Method 2: Binary Download (Linux)** ```bash # Check latest version: https://github.com/gohugoio/hugo/releases VERSION="0.152.2" wget https://github.com/gohugoio/hugo/releases/download/v${VERSION}/hugo_extended_${VERSION}_linux-amd64.deb sudo dpkg -i hugo_extended_${VERSION}_linux-amd64.deb ``` **Method 3: Docker** ```bash docker run --rm -it -v $(pwd):/src klakegg/hugo:ext-alpine ``` **Method 4: NPM Wrapper** (not recommended, may lag behind) ```bash npm install -g hugo-bin ``` **Verification:** ```bash hugo version # Should output: hugo v0.152.2+extended # ^^^^^^^^ Must show "+extended" ``` **Key Points:** - Extended edition required for SCSS/Sass - Version should be v0.149.0+ for best compatibility - NPM wrapper may be behind official releases - Pin version in CI/CD (see Step 7) ### Step 2: Project Scaffolding **Create new site with YAML configuration:** ```bash hugo new site my-site --format yaml cd my-site ``` **Directory structure created:** ``` my-site/ ├── hugo.yaml # Configuration (YAML format) ├── archetypes/ # Content templates │ └── default.md ├── content/ # All your content goes here ├── data/ # Data files (JSON/YAML/TOML) ├── layouts/ # Template overrides ├── static/ # Static assets (images, CSS, JS) ├── themes/ # Themes directory └── public/ # Build output (generated, git ignore) ``` **CRITICAL:** - Use `--format yaml` for CMS compatibility - Never commit `public/` directory to Git - Create `.gitignore` immediately (see Step 3) ### Step 3: Theme Installation **Recommended Method: Git Submodule** ✅ ```bash # Popular themes: # - PaperMod (blogs): https://github.com/adityatelange/hugo-PaperMod # - Book (docs): https://github.com/alex-shpak/hugo-book # - Academic (research): https://github.com/HugoBlox/theme-academic-cv # - Ananke (general): https://github.com/theNewDynamic/gohugo-theme-ananke git submodule add --depth=1 https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod ``` **Alternative: Hugo Modules** (advanced) ```bash hugo mod init github.com/username/my-site # In hugo.yaml: # module: # imports: # - path: github.com/adityatelange/hugo-PaperMod ``` **Add theme to hugo.yaml:** ```yaml theme: "PaperMod" ``` **When cloning project with submodules:** ```bash git clone --recursive https://github.com/username/my-site.git # Or if already cloned: git submodule update --init --recursive ``` **Key Points:** - Git submodules are recommended over manual downloads - `--depth=1` saves space (no theme history) - Always run `git submodule update --init --recursive` after clone - Hugo Modules are more advanced but don't require Git submodules ### Step 4: Configuration **hugo.yaml - Complete Example (PaperMod blog):** ```yaml baseURL: "https://example.com/" title: "My Hugo Blog" theme: "PaperMod" languageCode: "en-us" defaultContentLanguage: "en" enableRobotsTXT: true buildDrafts: false buildFuture: false buildExpired: false enableEmoji: true minify: disableXML: true minifyOutput: true params: env: production title: "My Hugo Blog" description: "A blog built with Hugo and PaperMod" author: "Your Name" ShowReadingTime: true ShowShareButtons: true ShowPostNavLinks: true ShowBreadCrumbs: true ShowCodeCopyButtons: true defaultTheme: auto # dark, light, auto socialIcons: - name: twitter url: "https://twitter.com/username" - name: github url: "https://github.com/username" menu: main: - identifier: posts name: Posts url: /posts/ weight: 10 - identifier: about name: About url: /about/ weight: 20 outputs: home: - HTML - RSS - JSON # Required for search ``` **Configuration Formats:** - **YAML** (recommended): `hugo.yaml` - Better CMS compatibility - **TOML** (legacy): `hugo.toml` - Default but problematic with Sveltia CMS - **JSON**: `hugo.json` - Rarely used **Environment-Specific Configs:** ``` config/ ├── _default/ │ └── hugo.yaml ├── production/ │ └── hugo.yaml # Overrides for production └── development/ └── hugo.yaml # Overrides for local dev ``` ### Step 5: Content Creation **Create content with Hugo CLI:** ```bash # Blog post hugo new content posts/my-first-post.md # Page hugo new content about.md # Nested documentation hugo new content docs/getting-started/installation.md ``` **Frontmatter Format (YAML recommended):** ```yaml --- title: "My First Post" date: 2025-11-04T10:00:00+11:00 draft: false tags: ["hugo", "blog"] categories: ["General"] description: "A brief description for SEO" cover: image: "/images/cover.jpg" alt: "Cover image" --- # Post content starts here This is my first Hugo blog post! ``` **TOML Frontmatter (for reference only):** ```toml +++ title = "My First Post" date = 2025-11-04T10:00:00+11:00 draft = false tags = ["hugo", "blog"] +++ ``` **Key Points:** - Use `---` delimiters for YAML frontmatter - Use `+++` delimiters for TOML frontmatter - `draft: false` required for post to appear in production - `date` in future = post won't publish (unless `--buildFuture` flag used) - Content goes after frontmatter closing delimiter ### Step 6: Build and Development **Development server (with live reload):** ```bash # Start server hugo server # With drafts visible hugo server --buildDrafts # With future-dated posts hugo server --buildFuture # Bind to specific port hugo server --port 1314 # Access at: http://localhost:1313 ``` **Production build:** ```bash # Basic build hugo # With minification (recommended) hugo --minify # With specific baseURL (for deployment) hugo --minify --baseURL https://example.com # Or use environment variable hugo --minify -b $CF_PAGES_URL ``` **Build Output:** - All generated files go to `public/` directory - Typical build time: <100ms for small sites, <5s for 1000+ pages - Hugo is the **fastest** static site generator **Key Points:** - Development server has live reload (HMR) - Production build should use `--minify` - Never commit `public/` directory - Build time is extremely fast (Hugo is written in Go) ### Step 7: Cloudflare Workers Deployment **Create wrangler.jsonc:** ```jsonc { "name": "my-hugo-site", "compatibility_date": "2025-01-29", "assets": { "directory": "./public", "html_handling": "auto-trailing-slash", "not_found_handling": "404-page" } } ``` **Manual deployment:** ```bash # Build site hugo --minify # Deploy to Workers npx wrangler deploy ``` **GitHub Actions (Automated):** Create `.github/workflows/deploy.yml`: ```yaml name: Deploy to Cloudflare Workers on: push: branches: [main] jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: submodules: recursive # Important for theme submodules! - name: Setup Hugo uses: peaceiris/actions-hugo@v2 with: hugo-version: '0.152.2' extended: true - name: Build run: hugo --minify - name: Deploy to Cloudflare Workers uses: cloudflare/wrangler-action@v3 with: apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} ``` **Key Points:** - `assets.directory` must be `"./public"` (Hugo's output) - `html_handling: "auto-trailing-slash"` handles Hugo's URL structure - `not_found_handling: "404-page"` serves Hugo's 404.html - Always pin Hugo version in CI/CD (prevents version mismatch errors) - Use `submodules: recursive` for theme submodules --- ## Critical Rules ### Always Do ✅ **Install Hugo Extended** (not Standard) - required for SCSS/Sass support in themes ✅ **Use YAML configuration** (`--format yaml`) - better CMS compatibility than TOML ✅ **Add themes as Git submodules** - easier updates and version control ✅ **Set correct baseURL** - prevents broken asset links on deployment ✅ **Pin Hugo version in CI/CD** - prevents version mismatch errors between local and deployment ✅ **Add `public/` to .gitignore** - build output should not be committed ✅ **Use `draft: false`** - drafts don't appear in production builds ✅ **Clone with `--recursive` flag** - ensures theme submodules are fetched ✅ **Use relative paths for images** - `/images/photo.jpg` not `../images/photo.jpg` ✅ **Test build before deploying** - catch errors locally with `hugo --minify` ### Never Do ❌ **Don't install Hugo Standard** - most themes require Extended edition ❌ **Don't use TOML config with Sveltia CMS** - has known bugs, use YAML instead ❌ **Don't commit `public/` directory** - it's generated output, not source code ❌ **Don't use different Hugo versions** - local vs CI/CD version mismatch causes errors ❌ **Don't forget `submodules: recursive`** - themes won't load in CI/CD ❌ **Don't hardcode production URLs** - use `-b $CF_PAGES_URL` or environment configs ❌ **Don't push `resources/_gen/`** - generated assets, should be in .gitignore ❌ **Don't use future dates carelessly** - posts won't publish until date passes ❌ **Don't skip `.hugo_build.lock`** - add to .gitignore ❌ **Don't mix YAML and TOML** - stick to one format throughout project --- ## Known Issues Prevention This skill prevents **9** documented issues: ### Issue #1: Version Mismatch (Hugo vs Hugo Extended) **Error**: `Error: SCSS support not enabled` **Source**: https://gohugo.io/troubleshooting/faq/#i-get-this-feature-is-not-available-in-your-current-hugo-version **Why It Happens**: Theme requires SCSS/Sass processing, but Hugo Standard doesn't include it **Prevention**: Always install Hugo Extended edition. Verify with `hugo version | grep extended` ### Issue #2: baseURL Configuration Errors **Error**: Broken CSS/JS/image links, 404s on all assets **Source**: Hugo docs, Cloudflare Pages guide **Why It Happens**: `baseURL` in config doesn't match deployment URL **Prevention**: - Use environment-specific configs (`config/production/hugo.yaml`) - Or use build flag: `hugo -b $CF_PAGES_URL` - Or set correct baseURL in hugo.yaml before build ### Issue #3: TOML vs YAML Configuration Confusion **Error**: Sveltia CMS fails to parse frontmatter, config not loading **Source**: Sveltia CMS documentation, community reports **Why It Happens**: Mixing TOML and YAML, or using TOML with Sveltia CMS (which has bugs) **Prevention**: Standardize on YAML format. Create sites with `--format yaml` flag ### Issue #4: Hugo Version Mismatch (Local vs Deployment) **Error**: Features work locally but fail in CI/CD, or vice versa **Source**: GitHub Actions hugo-setup, Cloudflare Pages docs **Why It Happens**: Different Hugo versions have different features/bugs **Prevention**: - Pin Hugo version in `hugo.yaml` metadata or README - Set `HUGO_VERSION` in Cloudflare Pages - Use `hugo-version: '0.152.2'` in GitHub Actions ### Issue #5: Content Frontmatter Format Errors **Error**: Content files don't render, build fails with parse errors **Source**: Hugo content management documentation **Why It Happens**: Wrong delimiters (`---` vs `+++`), invalid YAML/TOML syntax **Prevention**: - YAML: use `---` delimiters - TOML: use `+++` delimiters - Validate frontmatter with Sveltia CMS or YAML linter ### Issue #6: Theme Not Found Errors **Error**: `Error: module "PaperMod" not found`, blank site **Source**: Hugo themes documentation **Why It Happens**: Theme not installed, or `theme` not set in config, or Git submodules not initialized **Prevention**: - Set `theme: "PaperMod"` in hugo.yaml - Use `git submodule add` for theme installation - Always `git submodule update --init --recursive` after clone ### Issue #7: Date Time Warp Issues **Error**: Content missing on deployed site but visible locally **Source**: Hugo date handling documentation **Why It Happens**: Future-dated posts published locally (with `--buildFuture`) but not in production **Prevention**: - Use current or past dates in frontmatter - Or add `--buildFuture` flag to production build - Check `date` field in frontmatter ### Issue #8: Public Folder Conflicts **Error**: Stale content on site, Git conflicts in `public/` **Source**: Hugo project structure best practices **Why It Happens**: Committing `public/` directory when it should be build output only **Prevention**: - Add `public/` to `.gitignore` - Rebuild on every deployment - Never commit generated files ### Issue #9: Module Cache Issues **Error**: `failed to extract shortcode`, corrupted module cache **Source**: Hugo modules documentation, GitHub issues **Why It Happens**: Corrupted Hugo Modules cache (when using modules instead of submodules) **Prevention**: - Run `hugo mod clean` to clear cache - Run `hugo mod tidy` periodically - Or use Git submodules instead of modules (more reliable) --- ## Configuration Files Reference ### hugo.yaml (Full Production Example) ```yaml baseURL: "https://example.com/" title: "My Hugo Blog" theme: "PaperMod" languageCode: "en-us" defaultContentLanguage: "en" enableRobotsTXT: true buildDrafts: false buildFuture: false buildExpired: false enableEmoji: true pygmentsUseClasses: true summaryLength: 30 minify: disableXML: true minifyOutput: true params: env: production title: "My Hugo Blog" description: "A blog built with Hugo and PaperMod" keywords: [Blog, Hugo, Tech] author: "Your Name" images: ["/images/og-image.jpg"] DateFormat: "January 2, 2006" defaultTheme: auto # dark, light, auto disableThemeToggle: false ShowReadingTime: true ShowShareButtons: true ShowPostNavLinks: true ShowBreadCrumbs: true ShowCodeCopyButtons: true ShowWordCount: true ShowRssButtonInSectionTermList: true UseHugoToc: true disableSpecial1stPost: false disableScrollToTop: false comments: false hidemeta: false hideSummary: false showtoc: true tocopen: false assets: disableHLJS: true disableFingerprinting: false label: text: "My Hugo Blog" icon: /favicon.ico iconHeight: 35 homeInfoParams: Title: "Hi there 👋" Content: Welcome to my blog. socialIcons: - name: twitter url: "https://twitter.com/" - name: github url: "https://github.com/" - name: linkedin url: "https://linkedin.com/" - name: rss url: "/index.xml" cover: hidden: false hiddenInList: false hiddenInSingle: false editPost: URL: "https://github.com/username/repo/tree/main/content" Text: "Suggest Changes" appendFilePath: true fuseOpts: isCaseSensitive: false shouldSort: true location: 0 distance: 1000 threshold: 0.4 minMatchCharLength: 0 keys: ["title", "permalink", "summary", "content"] menu: main: - identifier: search name: Search url: /search/ weight: 10 - identifier: posts name: Posts url: /posts/ weight: 20 - identifier: archives name: Archives url: /archives/ weight: 30 - identifier: tags name: Tags url: /tags/ weight: 40 - identifier: about name: About url: /about/ weight: 50 outputs: home: - HTML - RSS - JSON # Required for search functionality ``` **Why these settings:** - `buildDrafts: false` - prevents drafts in production - `enableRobotsTXT: true` - SEO best practice - `minifyOutput: true` - smaller file sizes - `defaultTheme: auto` - respects user's system preference - `JSON` output - enables client-side search - Social icons - improves discoverability ### wrangler.jsonc (Cloudflare Workers) ```jsonc { "name": "my-hugo-site", "compatibility_date": "2025-01-29", "assets": { "directory": "./public", "html_handling": "auto-trailing-slash", "not_found_handling": "404-page" } } ``` **Why these settings:** - `directory: "./public"` - Hugo's build output - `html_handling: "auto-trailing-slash"` - matches Hugo's URL structure - `not_found_handling: "404-page"` - serves Hugo's custom 404.html ### .gitignore (Essential) ```gitignore # Hugo /public/ /resources/_gen/ .hugo_build.lock # OS .DS_Store Thumbs.db # Editor .vscode/ .idea/ *.swp *.swo # Dependencies (if using npm for tools) node_modules/ package-lock.json # Logs *.log ``` --- ## Sveltia CMS Integration (Recommended) ### Why Sveltia CMS for Hugo? ✅ **Hugo is Sveltia's primary use case** - designed specifically for Hugo ✅ **Simple setup** - 2 static files, no build step required ✅ **No npm dependencies** - single CDN script ✅ **Local backend** - test CMS locally without Git ✅ **YAML frontmatter** - fully compatible ✅ **No security vulnerabilities** - lightweight, maintained ✅ **Active development** - focused on static site generators ### Setup (5 Minutes) **1. Create admin interface** - `static/admin/index.html`: ```html