Skip to content
Public template

Repository files navigation

Hugolify template

Is a Github template for build easily a fast, accessible friendly and low carbon website!

Hugolify

Live demos

Each demo is a branch of this repository, deployed on Netlify.

https://www.hugolify.io/docs/showcase/

Requirements

Installation

After cloning or updating Hugo modules, run:

yarn install:hugolify && yarn install
# or: npm run install:hugolify && npm install
# or: pnpm run install:hugolify && pnpm install

The install:hugolify script chains two steps:

  1. hugo mod get downloads the Hugo modules declared in config/_default/module.yaml
  2. hugo mod npm pack collects the npm dependencies of each module (PostCSS plugins, design tokens…) into the packages/hugoautogen workspace

The final install step installs the resulting npm packages.

Run these commands whenever you add, remove, or update a Hugo module: the npm dependencies of a module are only available after this step.

Styling

The template uses hugolify-theme with the hugolify-theme-design-system styling module, declared in config/_default/module.yaml:

imports:
  - path: github.com/hugolify/hugolify-theme/v2
  - path: github.com/hugolify/hugolify-theme-design-system

To use Bootstrap instead, replace the styling module and import it before the theme, so that its legacy overrides of the theme's partials apply (the first import wins):

imports:
  - path: github.com/hugolify/hugolify-theme-bootstrap
  - path: github.com/hugolify/hugolify-theme/v2

Each styling module reads its PostCSS config from its own directory (postcss/design-system/ or postcss/bootstrap/), both are shipped with the template.

See hugolify-theme for the full architecture and how to build your own module.

Hugolify v1

The v1 template (Bootstrap bundled in hugolify-theme) lives on the v1 branch.

To move an existing v1 project to v2, follow the migration guide.

Documentation

https://www.hugolify.io/docs/

Sponsors

Hugolify is free and open source. If it saves you time or runs your sites, you can support its development on GitHub Sponsors.

License

Hugolify is free for personal or commercial projects (MIT license)

Releases

Sponsor this project

Used by

Contributors

Languages