Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 3.38 KB

README.md

File metadata and controls

70 lines (50 loc) · 3.38 KB

Hugo Brewm

Fine-brewed Hugo theme made open.

Demosite: https://hugo.brewm.co

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
  1. Add this theme as a Git submodule:
git submodule add https://github.com/foxihd/hugo-brewm themes/hugo-brewm
  1. Update your site's configuration in config.toml:
theme = "hugo-brewm"

Check the example site's configuration directory (./themes/hugo-brewm/exampleSite/config/_default) to explore available configuration options.

  1. Create a new post under content directory:
hugo new posts/my-first-post.md
  1. For building and deploying your Hugo site to GitHub Pages, copy the workflow file from ./themes/hugo-brewm/github/workflows/hugo.yml to your repository's root directory and initiate the GitHub Action.

Special Thanks

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

License

This theme is released under the MIT License.