Skip to content

foxihd/hugo-brewm

BranchesTags

Repository files navigation

hugo-brewm

Fine-brewed Hugo theme made open.

Minimum Hugo Version: v.0.135.0 GitHub Code Size GitHub Repo Size GitHub License: MIT

Demosite: https://foxihd.github.io/hugo-brewm/en/

A11y Console

Feature Highlights

  • Reader-first: Prioritizes speed1, privacy2, readability and accessibility with personalized settings for colors, fonts, BionRead and focus mode (It's Tracker Free!).

  • Inclusive: Graceful degradation design3 oriented with improved semantic HTML structure & WAI-ARIA attribute, printer-friendly plain vanilla website that remains fully functional even when JavaScript is disabled!

  • Scalable: Start small and grow into a thriving digital garden; with multi-author support, multilingual capabilities and content organization through taxonomy. Features include optional Pagefind search integration, RSS feed syndication (site-wide and series-specific), external feed embed over RSS, and social engagement via Giscus, Mastodon and Bluesky comments.

  • Frameworkless: Lower maintenance & carbon footprint by lesser resource usage. Hugo-brewm's combined JavaScript and stylesheet assets (excluding optional external libraries like MathJax, Katex or PageFind) totaling under 110KB and compressed to less than 30KB when Gzipped!

    All web assets listed below may be fetched once until the cache is purged or expired.

    Assets Filename Size Gzipped Note
    hugo-brewm.min.css ~58.8KB ~13.7KB Compiled site-wide stylesheet, could be less
    hugo-brewm.min.js ~28.8KB ~9.3KB Compiled site-wide javascript, could be less
    fediverse.min.js ~13.1KB ~4.1KB Mastodon & Bluesky comments, load if required
    verbatim.min.css ~4.4KB ~1.4KB Code block stylesheet, load if required

Acknowledgement

Note

It's almost Evergreen!

After about two years of development, this work are now entering slow development stage. Please, Feel free to contribute and keep in touch!

Keep Growing!
🌱🌱🌱

Translation

We currently support:

  • 🇬🇧 English
  • 🇮🇩 Indonesian

Please feel free to contribute to additional translation.

3rd Party Assets

The 3rd party assets listed bellow may be required:

3rd Party Assets Size Gzipped Note
pagefind-ui.js ~76.5KB ~21.0KB Search functionsite.Params.search.pagefind
purify.min ~21.7KB ~8.2KB DOM sanitizersite.Params.disableDOMPurify
katex.min.js ~270KB ~71.8KB KaTeX math engine.Params.math
katex.min.css ~22.8KB ~3.4KB KaTeX math style.Params.math
d3.v7.min.js ~273KB ~87.9KB Render network graph{{< network-graph >}}
tex-mml-chtml.js ~1.11MB ~249KB MathJax math engine.Params.mathJax
highlight.min.js ~117KB ~38.5KB Code Highlighting.Params.hljs

Web Fonts

Web fonts listed bellow may be selected, unless site.Params.typeface.webSafe or site.Params.posts.sfdefault is configured:

Web Fonts (woff2) Styles Size Note
base-ui 1 ~22KB Mandatory UI icon
Inconsolata 2 ~77KB Load on verbatim, disable on websafe fonts mode
OpenDyslexic 4 ~427KB Mandatory, load on OpenDyslexic mode
OpenDyslexic Mono 1 ~24KB Load on OpenDyslexic mode for verbatim
LexicaUltralegible 4 ~103KB default sans-serif, disable on websafe mode
Inter 4 ~454KB set onsite.Params.typeface.sans = Inter
Monserrat 4 ~514KB set onsite.Params.typeface.sans = Monserrat
Rosario 4 ~150KB set onsite.Params.typeface.sans = Rosario
EBGaramond 4 ~864KB default roman/serif, disable on websafe
Cormorant 4 ~516KB set onsite.Params.typeface.roman = Cormorant
Crimson 4 ~104KB set onsite.Params.typeface.roman = Crimson

Getting Started: Blog with Hugo and hugo-brewm

Installation

  1. Create a new Hugo site (for an existing hugo site, skip to step 2) :
hugo new site mysite
cd mysite
git init
  1. Add this theme as a Git submodule:
git submodule add https://github.com/foxihd/hugo-brewm themes/hugo-brewm
  1. Add theme = "hugo-brewm" to site's configuration in config.toml.
echo 'theme = "hugo-brewm"' >> config.toml

Preview Builds and Serves the Site

  1. Change to your site directory.
cd mysite
  1. Make sure the theme is initialized on new clone:
git submodule update --init --recursive
  1. To preview your changes locally before pushing to the repository, run Hugo's development server with the following command, make sure to update the baseURL to match your local IP address - this will make your site accessible across your local network:
hugo serve --minify --port=8080 --bind=0.0.0.0 --baseURL=http://192.168.0.1

Important

Please use the --minify options to strip white spaces; otherwise, some elements will have additional spaces.

  1. With Hugo running, you can now live configure your site and begin writing articles. Some templates might persist until you clear the build cache, please stop the running hugo server (ctrl + c) and before you rebuild, run:
hugo mod clean
  1. If you have PageFind enable on configuration, please index your site with Node:
npx pagefind --site "public"

Updating Theme

To update the theme to the latest changes, run the following commands:

  1. Change to your site directory.
cd mysite
  1. Update the theme submodule:
git submodule update --remote --merge themes/hugo-brewm
  1. Commit the changes.
git add themes/hugo-brewm
git commit -m "Update hugo-brewm theme"

Resolving Submodule Conflicts

My apologies for my bad practice on force updating, If you encounter conflicts when updating the submodule, here's an alternative approach:

  1. Change to your site directory
cd mysite
  1. Force remove the existing submodule
git submodule deinit -f themes/hugo-brewm
rm themes/hugo-brewm
  1. Re-add the submodule with force flag
git submodule add -f https://github.com/foxihd/hugo-brewm themes/hugo-brewm

Overriding Templates

To customize the theme's templates, create files with matching names in your site's root directory. These will override the default theme templates.

 mysite/
    ├── ...
    ├── assets/
    │   └── css/
    │       └── custom.css # This will replace theme's custom.css template
    ├── content/
    ├── layouts/
    │   ├── shortcodes/
    │   │   └── myshortcode.html # This will add {{< myshortcode >}} shortcodes
    │   ├── partials/
    │   │   └── header.html # This will replace theme's header.html template
    │   └── 404.html # This will replace theme's 404.html template
    ├── ...
    ├── static/
    └── themes/
        └── hugo-brewm/ # The remote theme
            ├── ...
            ├── assets/
            │   └── css/
            │       └── custom.css
            ├── layouts/
            │   ├── partials/
            │   │   └── header.html
            │   └── 404.html
            ├── static/
            └── ...

Host Web Fonts on Local Server

At the moment hugo-brewm use web fonts hosted on GitHub with short cache expiration policy (about ~5min), for optimal performance you can host the web fonts on your server with following steps:

  1. Change to your site directory
cd mysite
  1. Download fonts URIs to site fonts directory with wget -i fonts.uri.txt, the command bellow will download all available fonts (Please discard unused fonts on the URI list):
wget -i /themes/hugo-brewm/static/css/fonts/fonts.uri.txt -P /static/css/fonts/
  1. Configure site.Params.typeface.localHost on hugo.toml/config.toml to choose local directory during CSS compilation.
[params]
    [params.typeface]
        localHost = true

Override Flowlines Directory

When site.Params.Feed.Flowlines is set, flowlines will fill the missing articles cover on the feed view. You can override this random flowlines to picture of abstract, mesh or anything you like with:

[params]
    [params.feed]
        OverrideFlowlinesDir = 'https://example.com/i-prefer/random-cat-directory/'
        FlowlinesLimit = 50
        flowlinesExt = 'jpg'

You need to name the illustration numerically starting from the number 1 to the value of site.Params.Feed.FlowlinesLimit.

random-cat-directory/
    ├── 1.jpg
    ├── 2.jpg
    ├── 3.jpg
    └── ...

Deploy on GitHub Pages

To deploy your Hugo site with PageFind on GitHub Pages, copy the workflow file from ./themes/hugo-brewm/github/workflows/hugo.yml to your repository's workflow directory and start the GitHub Action.

Deploy on Gitlab Pages

To deploy your Hugo site with PageFind on Gitlab Pages, copy the workflow file from ./themes/hugo-brewm/.gitlab-ci.yml to your repository's workflow directory and start the Gitlab CI/CD pipeline.

Configuration

The following configuration options are available for hugo-brewm:

## Base URL for the site
baseURL = 'https://example.com'
## Site title
title = 'Example'
## Use hugo-brewm theme
theme = 'hugo-brewm'
## Enable Git information for pages, (e.g. lastMod date information)
enableGitInfo = true
## Convert all URLs to absolute URLs
canonifyURLs = true
## Default language for content
defaultContentLanguage = 'en'
## Put default language in subdirectory
defaultContentLanguageInSubdir = true
## Generate a robots.txt
enableRobotsTXT = true
## Use sections for main menu
# sectionPagesMenu = 'main'
## Files to ignore when building site
ignoreFiles = [ '\.redacted', '\.old','\.bak', '\.tmp', '\.swp', '\.DS_Store']

## markup configuration
[markup]

    [markup.highlight]
        ## Enable code fence highlighting
        codeFences = true
        ## Use hugo-brewm classes for verbatim styling
        noClasses = false

## Sitemap configuration
[sitemap]
    ## Change frequency setting (will affect posts listings layout): 'always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'never'
    changeFreq = 'monthly'

## Taxonomy register
[taxonomies]
    category = 'categories'
    tag = 'tags'
    author = 'author'
    # series = 'series'
    # lenses = 'lenses'
    # cameras = 'cameras'

## Site parameters
[params]
    ## Site title
    title = "Example"
    ## Site description
    description = "An ExampleSite built with Hugo and Hugo-Brewm theme"
    ## Copyright notice on colophon
    copyright = "Copyright 2025 © Author"
    ## Hide "powered by hugo" on colophon
    HideHugoCredit = true
    ## Enable extended metadata (social cards)
    extMeta = true
    ## Enable coffee metric
    coffeeStat = true
    ## Default social card image, recommended resolution: 1200 x 630px
    # images = "example.com/img/social-share.jpg"
    ## Do not block AI user agent for robot.txt
    AllowAIRobots = false
    ## or BearMode--Minimize clutter for small site; Disable breadcrumbs menu, share button, related posts, colophon and redaction history.
    ZenMode = false
    ## Disable black background on main-footer
    DisableFootBar = false
    ## Merge site license, footer menu and coffee stat
    unifiedFooter = true

    ## At the moment, analytics can be added manually by creating a custom template at `mysite/layouts/partials/analytics.html`
    [params.analytics]
        ## Choose where to append analytics script: use 'head' to place within <head> tags, or 'body' to place before closing </body> tag.
        append = 'body'

    ## Author information
    [params.author]
        ## site author's name
        name = 'Author Name'
        ## Author's email
        email = 'email@example.com'
        ## Other method to customize author and co-authors information
        coauthor = [
            {name = "A.N. Other", bio = "Lorem ipsum dolor sit amet."}
        ]

    ## Comments configuration
    [params.comments]
        ## Disable comments (disable fediverse comments)
        disabled = false
        ## Comment platform selection, pending rule implementation
        # platform = 'giscus'

    ## Favicon configuration
    [params.favicon]
        # png = '/favicon-96x96.png'
        # svg = '/favicon.svg'
        # ico = '/favicon.ico'
        # apple = '/apple-touch-icon.png'
        # appTitle = 'App Title'
        # webmanifest = '/site.webmanifest'

    ## Fediverse integration settings for verification
    [params.fediverse]
        ## Fediverse instance URL
        instance = 'example.com'
        ## Fediverse username
        username = 'username'

    ## Feed display settings
    [params.feed]
        ## Enable flowlines
        flowlines = true
        ## Limit number of flowlines with maximum 42
        flowlinesLimit = 21
        ## Overide Flowlines illustration
        OverrideFlowlinesDir = 'https://raw.githubusercontent.com/foxihd/hugo-et-hd/master/static/svg/flowlines/'
        ## Illustration extension on overiding flowlines
        flowlinesExt = 'svg'

    ## Giscus configuration
    [params.giscus]
        ## Repository name
        repo = "username/repository"
        ## Repository ID
        repoID = "R_xxx"
        ## Discussion category
        category = "Comments"
        ## Category ID
        categoryID = "DIC_xxx"
        ## Discussion mapping
        mapping = "og:title"
        ## Enable reactions
        reactionsEnabled = "1"
        ## Emit discussion metadata
        emitMetadata = "0"
        ## Comment input box position
        inputPosition = "bottom"
        ## Color theme
        theme = "light"
        ## Loading behavior
        loading = "lazy"

    ## Home page display settings
    [params.home]
        ## Disable slide carousel
        disableSlide = false
        ## Disable taxonomy listing carousel
        disableListing = false
        ## Select taxonomy listing to be featured
        # featuredListing = ['categories', 'series', 'author', 'cameras', 'lenses']
        ## include section nodes in json
        includeSectionInJson = false

    ## Logo configuration
    [params.logo]
        ## Light mode logo mark
        logoMark = 'https://example.com/logoMark.svg'
        ## Dark mode logo mark
        logoMarkDark = 'https://example.com/logoMarkDark.svg'
        ## Enable logo type
        logoType = true

    ## Post display settings
    [params.posts]
        ## Enable text justification
        justifying = false
        ## Disable paragraph indentation
        noIndent = false
        ## Use sans-serif fonts as default
        sfdefault = false
        ## Show colophon section (including QR code)
        colophon = true
        ## disable redaction history
        disableHistory = false
        ## SHow related content
        related = true
        ## Show share buttons
        share = true
        ## enable section numbering
        secnum = false

    ## Search configuration
    [params.search]
        ## Enable search functionality, please index your site first
        enable = true
        ## Use pagefind search when javascript enabled, currently only 'pagefind' is supported, further options to be determined
        pagefind = true
        ## fallback searchbox when javascript disabled, currently the options limited to 'mojeek', otherwise duckduckgo will be used
        # fallback = 'mojeek'

    ## Extended Metadata and Social card configuration
    [params.socialCard]
        ## Enable twitter and opengraph social cards (same as .Params.extMeta)
        enable = true
        ## Default social card image, same as .Params.images
        # images = "img/social-share.jpg"
        ## Enable Twitter cards
        # twitter = true
        ## Twitter creator handle
        # twitterCreator = "@username"
        ## Twitter site handle
        # twitterSite = "@username"

        ## Enable OpenGraph
        # opengraph = true
        ## Facebook App ID
        # facebookAppID = "123456789"
        ## Facebook Admin ID
        # facebookAdmin = "USER_ID"

        ## Schema.org (EXPERIMENTAL, not fully supported body tags)
        # schema = true
        ## JsonLD (EXPERIMENTAL, cannot validate permalink)
        # jsonLD = true

    ## Typography settings
    [params.typeface]
        ## Use web safe fonts (will overide font selection below)
        webSafe = false
        ## Serif font selection: 'Cormorant' 'EB Garamond' and 'crimson' (default)
        roman = 'crimson'
        ## Sans-serif font selection: 'Inter' 'Montserrat' 'Rorasio' and 'Lexica Ultralegible' (default)
        sans = 'inter'
        ## Host fonts on local host instead of GitHub
        localHost = true

Support

Most of us love coffee, aren't we?

For what it's worth. This theme was originally made for my tiny coffee business that I work on myself. But things have to shifted in last two years, as coffee prices hikes due to shortages induced by climate change. I open my github sponsor if you'd love to help me. I would appreciate it too if you saved your morning brew by supporting your local coffee shop. That's maybe one of the small ethical revolutions we can do everyday if addressing our planet's issues can't be done in couple of earth's revolutions. I hope this will help you recognise.

Keep brewing! :)

Special Thanks

This project could not be made, without a lot efforts of — thank to:

License

This theme is released under the MIT License.

Footnotes

  1. Note that actual speeds may vary depending on content and configuration, user devices and policy of your hosting provider. Here are some benchmarks from the exampleSite that deployed under a minute on GitHub Pages; Websitecarbon.com & Lighthouse Metrics. ↩

  2. This theme does not include a cookie consent banner or any pre-configured web analytics or advertisements. While comments from the fediverse can be viewed without cookies, Giscus, or custom web analytics & advertisements may need local storage to be enabled, which means a cookie consent banner is necessary. ↩

  3. This theme is intended for browsers from 2016 or later and does not support Internet Explorer. ↩

About

Fine-brewed Hugo theme made open

foxihd.github.io/hugo-brewm/

Topics

blog hugo-theme accessibility hugo a11y personal-website blog-theme frameworkless hugo-blog-theme inclusive-design digital-garden giscus graceful-degradation

Resources

Readme

License

MIT license
Activity

Stars

69 stars

Watchers

0 watching

Forks

23 forks
Report repository

Releases 30

v2.2.0 Latest
Aug 3, 2025
+ 29 releases

Sponsor this project

 
Learn more about GitHub Sponsors

Languages