hugo-template
January 6, 2026 ยท View on GitHub
hugo-template
Template repository for Jamstack projects.
- Client:
- Netlify URL: https://hugo-template.netlify.app/
- Production URL:
Installing
You need Hugo installed on your machine: https://gohugo.io/getting-started/quick-start/
This repository is set up to be developed with Visual Studio Code editor. Please install reccommended extensions listed in extensions.json
If this is your first time running the project, run
npx husky init
When you have that run one of these commands for local dev server:
hugo server or npm run dev
and open your local site on http://localhost:1313/
Development
We use BEM naming convention for CSS class names.
We follow the standard Javascript style.
Linters
There are 3 linters set up:
Linter Configuration Files
stylelint.config.js- Stylelint configuration using ES moduleseslint.config.js- ESLint configuration using ES modules.htmlhintrc- HTMLHint configuration
Running Linters
# Run all linters
npm run lint
# Run individual linters
npx stylelint "**/*.scss"
npx eslint .
npx htmlhint 'layouts/**/*.html'
Auto-fixing
Linters will automatically fix issues when possible:
- VS Code: Auto-fixes on save (if recommended extensions are installed)
- Command line: Use
--fixflag with eslint and stylelint - Pre-commit hook: Automatically runs lint-staged which fixes staged files
Pre-commit Hook
A pre-commit git hook is configured using Husky and lint-staged. It:
- Runs linters only on staged files for better performance
- Auto-fixes issues when possible
- Prevents commits if there are unfixable errors
The hook configuration is in .husky/pre-commit and runs npx lint-staged, which uses the lint-staged configuration in package.json.
Deployment
To deploy to production, push to main branch
Development URL
There is no development URL out of the box. To create this environment, follow these steps:
- create branch
develop - Go to Netlify dashboard -> your site -> Settings -> Build & deploy -> Deploy contexts -> Edit settings
- Under Branch deploys select Let me add individual branches and add
develop - push some code to
developbranch and see it on https://develop--hugo-template.netlify.app
Additional setup
These configurations are optional based on the demands of your project.
Configure Github Actions
See How to Configure Github Actions on a Site.
Configure Decap CMS + Netlify Identity
See How to enable Netlify Identity for Decap CMS on a site.
Netlify Large Media
Netlify large media is (deprecated)[https://answers.netlify.com/t/large-media-feature-deprecated-but-not-removed/100804]
Don't use it with new projects anymore. Preferably use cloudinary instead
Hugo shims dependencies
See How to use Hugo shims dependencies.
Built With
Dependencies
Last updated: July 2025: all dependencies are on their latest versions.
Key development dependencies:
- ESLint 9.13.0 with neostandard configuration
- Stylelint 16.10.0 with SCSS support
- HTMLHint 1.1.4
- Husky 9.1.6 for Git hooks
- lint-staged 16.1.2 for pre-commit linting
- PostCSS 8.5.6 with PurgeCSS and Autoprefixer
The project uses ES modules ("type": "module") for modern JavaScript configuration files.