# Hugo Brewm > Fine-brewed Hugo theme made open. Demosite: [https://foxihd.github.io/hugo-brewm/en/](https://foxihd.github.io/hugo-brewm/en/) ## Feature Highlights - **Reader-first**: Prioritizes readability and accessibility with personalized settings for colors, fonts, and BionRead mode. - **Inclusive**: Graceful degradation design oriented with improved semantic HTML structure & WAI-ARIA attribute, the site remains fully functional even when JavaScript is disabled! - **Scalable**: Support for multiple authors and languages, optional Pagefind search, external feed over RSS and Fediverse-powered commenting system. - **Frameworkless**: Lower maintenace & carbon footprint by lesser resource usage. ## Installation 1. Create a new Hugo site (for an existing hugo site, skip to step 2) : ``` hugo new site mysite cd mysite git init ``` 2. Add this theme as a Git submodule: ``` git submodule add https://github.com/foxihd/hugo-brewm themes/hugo-brewm ``` 3. Update your site's configuration in `config.toml`: ``` theme = "hugo-brewm" ``` ## Configuration ### Configuration options The following configuration options are available for hugo-brewm: ```toml ## Base URL for the site baseURL = 'https://foxihd.github.io/hugo-brewm/' ## 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 ## Use sections for main menu # sectionPagesMenu = 'main' ## Files to ignore when building site ignoreFiles = [ '\.redacted', '\.old','\.bak', '\.tmp', '\.swp', '\.DS_Store'] ## Enable code fence highlighting [markup] [markup.highlight] codeFences = true ## Sitemap configuration [sitemap] ## Change frequency setting (will affect posts listings layout): 'always', 'hourly', 'daily', 'weekly', 'monthly', 'yearly', 'never' changeFreq = 'monthly' ## Site parameters [params] ## Site title title = "Example" ## Site description description = "An ExampleSite built with Hugo and Hugo-Brewm theme" ## Copyright notice copyright = "Copyright 2025 (c) Foxxi" ## Enable extended metadata (social cards) extMeta = true ## Enable coffee metric coffeeStat = true ## Author information [params.author] ## site author's name name = 'Author Name' ## Author's email (will be used for RSS feed) email = 'email@example.com' ## Other method to customize author and co-authors information coauthor = [ {name = "A.N. Other", bio = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."} ] ## Comments configuration [params.comments] ## Disable comments (disable fediverse comments) disabled = false ## Comment platform selection, currently only 'fediverse' is supported, further options to be determined # platform = 'fediverse' ## Fediverse integration settings [params.fediverse] ## Fediverse instance URL instance = 'example.com' ## Fediverse username username = 'username' ## 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 ## Feed display settings [params.feed] ## Enable flowlines flowlines = true ## Limit number of flowlines flowlinesLimit = 21 ## Home page display settings [params.home] ## Disable slide carousel disableSlide = false ## Disable taxonomy listing carousel disableListing = false ## Post display settings [params.posts] ## Enable text justification justifying = false ## Disable paragraph indentation noIndent = false ## Show colophon section (including QR code) colophon = true ## disable redaction history disableHistory = false ## SHow related content related = true ## Show share buttons share = true ## Search configuration [params.search] ## Enable search functionality, use duckduckgo (no javascript) enable = true ## Use pagefind search when javascript enabled, currently only 'pagefind' is supported, further options to be determined pagefind = true ## Typography settings [params.typeface] ## Use web safe fonts (will overide font selection below) webSafe = false ## Serif font selection roman = 'crimson' ## Sans-serif font selection sans = 'inter' ## Extended Metadata and Social card configuration [params.socialCard] ## Enable twitter and opengraph social cards (same as .params.extMeta) enable = true ## Default social card image, recommended resolution: 1200 x 630px # image = "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 ``` ### Configuration for GitHub Pages Deployment To deploy your Hugo site with PageFind on GitHub Pages, simply copy the workflow file located at [./themes/hugo-brewm/github/workflows/hugo.yml](https://github.com/foxihd/hugo-brewm/blob/main/.github/workflows/hugo.yml) into your repository's workflow directory and start the GitHub Action. ### Configuration for Gitlab Pages Deployment To deploy your Hugo site with PageFind on Gitlab Pages, copy the workflow file from [./themes/hugo-brewm/.gitlab-ci.yml](https://github.com/foxihd/hugo-brewm/blob/main/.gitlab-ci.yml) to your repository's workflow directory and start the Gitlab CI/CD pipeline. ## Translation We currently only support Indonesian and English. Please feel free to contribute to additional [translation](https://github.com/foxihd/hugo-brewm/blob/main/i18n/). ## Special Thanks This project could not be made, without a lot efforts of — thank to: - [Aliftype/amiri](https://github.com/aliftype/amiri) - for Amiri. - [Alvarotrigo on Codepen](https://codepen.io/alvarotrigo/pen/rNbxNWg) - for Logotype. - [Antijingoist/opendyslexic/](https://github.com/antijingoist/opendyslexic/) - for OpenDyslexic typeface. - [Datalog/qrcode-svg](https://github.com/datalog/qrcode-svg) - for page QR code generation. - [Dpecos/mastodon-comments](https://github.com/dpecos/mastodon-comments) - for Mastodon comments. - [Georgd/EB-Garamond](https://github.com/georgd/EB-Garamond), [Imedadel/typeface-eb-garamond-latest/](https://github.com/imedadel/typeface-eb-garamond-latest/) & [Googlefonts/ebgaramond-specimen/](https://github.com/googlefonts/ebgaramond-specimen/) - for serif typeface. - [GoogleFonts/Inconsolata](https://github.com/googlefonts/Inconsolata) - for teletype typeface. - [IcoMoon](https://icomoon.io) - for icon font. - [JulietaUla/Montserrat](https://github.com/JulietaUla/Montserrat) - for sans-serif typeface. - [Markmead/JS Bionic Reading](https://github.com/markmead/js-bionic-reading) - for BionRead support. - [Mrozilla on codepen](https://codepen.io/mrozilla/pen/OJJNjRb) - for dark/light mode toggle style. - [Msurguy/Flow Lines](https://github.com/msurguy/flow-lines) - for generated feature images. - [Omnibus-Type/Rosario](https://github.com/Omnibus-Type/Rosario) - for sans-serif typeface. - [Risilab/Cormorant](https://github.com/risilab/cormorant) - for serif typeface. - [Rsms/Inter](https://github.com/rsms/inter) - for sans-serif typeface. - [Skoch/Crimson](https://github.com/skosch/Crimson) - for serif typeface. - [Slashformotion/Hugo Tufte](https://github.com/slashformotion/hugo-tufte) - for figure & marginpar shortcodes. ## License This theme is released under the MIT License.