https://github.com/commitconfirmed/hugo-git-pages-starter

Starter pack for a Hugo Blog on GitHub Pages
https://github.com/commitconfirmed/hugo-git-pages-starter

Last synced: 9 months ago
JSON representation

Starter pack for a Hugo Blog on GitHub Pages

• Host: GitHub
• URL: https://github.com/commitconfirmed/hugo-git-pages-starter
• Owner: commitconfirmed
• License: mit
• Created: 2025-03-23T06:29:23.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-03-27T10:35:50.000Z (9 months ago)
• Last Synced: 2025-03-27T11:35:37.347Z (9 months ago)
• Language: Dockerfile
• Size: 6.84 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hugo-git-pages-starter

Starter pack for a Hugo Blog on GitHub Pages

See the full guide for using this repo [here](https://commitconfirmed.github.io/posts/hugo-github-pages-starter/)

https://commitconfirmed.github.io/posts/hugo-github-pages-starter/

Try it out in codespaces

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/commitconfirmed/hugo-git-pages-starter?quickstart=1&devcontainer_path=.devcontainer%2Fdevcontainer.json)

## TLDR

- Create a GitHub account

- Create a new public repo called **username**.github.io replacing username your GitHub username 

- Clone this repo into your repo

- Update the `~/site/hugo.toml` file with your own personal details

- Update the `~/site/content/about/index.md` file with your own personal details

- See the `~/site/content/posts/` directory for an example blog bost. 

  - Create a new folder and `index.md` file to make your own blog post

- Update your repos Settings/Pages to deploy using Github Actions and create a workflow using the provided `~/.github/workflows/hugo.yml` file 

  - See the Hugo [Documentation](https://gohugo.io/host-and-deploy/host-on-github-pages/) for detailed instructions

- Commit some changes and push to Main and your blog should now be available at https://username.github.io

- (Optional) Apply any [Extras](https://commitconfirmed.github.io/posts/hugo-github-pages-starter/#extras)

Supports Local, Docker Compose or GitHub Codespaces development.