Skip to content

Repository files navigation

🐑 Blowfish Starter Template

⚑ A plug-and-play Hugo + Blowfish starter template that works on GitHub Pages, Netlify, Vercel, Render, and Cloudflare Pages.

Hugo Blowfish Deploy

⚑️ Quick Start

  1. πŸ‘† Click "Use this template"
  2. πŸ“¦ Create your own repository
  3. πŸš€ Deploy to your preferred platform:

🌍 Live Demo

Check out the live version of this template:


πŸš€ Deployment Guide

This template works across multiple platforms out-of-the-box:

😺 GitHub Pages

GitHub Pages

  1. Go to Settings β†’ Pages
  2. Set Source to GitHub Actions
  3. Push (or re-run workflow)

Your site will be live at: https://<your-username>.github.io/<repo-name>

Note

The workflow in gh-pages.yml will automatically build and deploy your site.

Disable/Delete it if you're not deploying with GitHub Pages.

Tip

Enable automatic theme updates (Optional)

Go to Settings β†’ Actions β†’ General and enable:

  • Read and write permissions
  • Allow GitHub Actions to create and approve pull requests

This enables update-blowfish.yml to create Pull Requests when Blowfish updates.

Disable/delete it if you don't want Blowfish update

☁️ Cloudflare Pages

Cloudflare

  1. Create a new project (with Pages, not Workers)
  2. Connect your repository
  3. Set framework to Hugo
    • Build command: hugo
    • Output directory: public
  4. Deploy

Tip

(Optional) Change build command to:

hugo --gc --minify

🐦 Netlify

Netlify Deploy to Netlify

  1. Import your repo
  2. Deploy

Note

The included netlify.toml handles everything automatically.

Delete it if you're not deploying to Netlify.

⚫️ Vercel

Vercel Deploy with Vercel

  1. Import your repo
  2. Deploy

Tip

(Optional) Add an Environment Variable:

HUGO_VERSION=0.155.3

🟒 Render

Render

  1. Create a Static Site
  2. Connect your repository
  3. Set build command to:
bash render.sh

Note

The included render.sh handles the build setup.

Delete it if you're not deploying to Render.


πŸ“ Project Structure

.
β”œβ”€β”€ config/_default/     # Hugo configuration
β”œβ”€β”€ content/             # Site content
β”œβ”€β”€ themes/blowfish/     # Blowfish theme
β”œβ”€β”€ render.sh            # Render build script
β”œβ”€β”€ netlify.toml         # Netlify config
└── .github/workflows/   # GitHub Actions

This template already includes:

So your site:

  • ⚑️ Builds immediately
  • πŸš€ Doesn’t break on first deploy
  • πŸ”§ Requires no initial setup

Important

  • Blowfish requires Hugo Extended for SCSS support
    • Recommended version: 0.155.3 or newer
  • All builds output to the public/ directory
  • πŸ”§ Designed to work without modifying configuration files
  • πŸ“¦ Works on both root domains and project subpaths

✏️ Customize Your Site

Head over to Blowfish Documentations: Basic Configuration


πŸ™Œ Credits

⭐ Support

If you found this useful, consider giving this repo a ⭐!

Note

This template is a non-CLI/terminal alternative to install and deploy Blowfish. If you want to install Blowfish via CLI/terminal on your local machine, see Blowfish Installation.

Curious how this was built from a phone? πŸ˜…

πŸ‘‰ Read the devlog: Building a Blowfish Starter Template

About

documents for lumesh -- a lighting shell

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

Generated from superiums/moon