Template project for sites built with Hugo, Decap, and Netlify
- Client:
- Netlify URL: https://hugo-template.netlify.app/
- Production URL:
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
npm install
and npx husky install
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/
We use BEM naming convention for CSS class names.
We follow the standard Javascript style.
There are 3 linters set up:
If quick fixes are possible, VS Code will fix them on save. A pre-commit git hook is also in place. It triggers all 3 linters on staged files, and if there are errors, it prevents the commit.
To deploy to production, push to main
branch
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
develop
branch and see it on https://develop--hugo-template.netlify.app
These configurations are optional based on the demands of your project.
See How to Configure Github Actions on a Site.
See How to enable Netlify Identity for Decap CMS on a site.
See (How to Enable Netlify Large Media on a Project)[https://github.com/poslovnimediji/knowledgebase/wiki/How-to-Enable-Netlify-Large-Media-on-a-Project]