Hugo TailwindCSS Starter

A starter project for Hugo and TailwindCSS v4.1
Ready to deploy in Vercel, GitHub Pages or Netlify 🚀
View Live »

Report Bug · Request Feature

Welcome

This starter project integrates Hugo with TailwindCSS v4.1 and is ready for deployment on Vercel, GitHub Pages or Netlify.

Built With

• 
• 
• 

Features

• Integration of Hugo and TailwindCSS v4.1
• Easy deployment with GitHub Pages, Netlify or Vercel
• Starter templates for rapid development

Installation

Ensure you have the following installed:

• Hugo (Extended Edition - at least v0.146.x)
• Node.js (at least v18.x)
• For deployment (optional):
  • Vercel Account or
  • Netlify Account
  • GitHub Account

To get a local copy up and running, follow these steps:

1. Clone the repository

   git clone https://github.com/odhyp/hugo-tailwindcss-starter.git

2. Navigate to the project directory

   cd hugo-tailwindcss-starter

3. Install the Node.js dependencies

   npm install

4. Run the development server

   npm run dev

5. When development is complete, build the optimized Hugo site

   npm run build

Roadmap

• Add deployment guides for other platforms like GitLab or Cloudflare Pages
• Include basic page layout components such as header and footer

See the open issues for a full list of proposed features (and known issues).

Deployment on GitHub Pages

1. Create a local branch gh-pages and push this branch to your remote repo:

$ git checkout -b gh-pages
$ git push --set-upstream origin gh-pages

1. If needed, adapt the deployment workflow file.

2. If you forked this repo in GitHub, allow GitHub actions for your forked repo.

3. Inspect your deployment: https://your-github-username.github.io/hugo-tailwindcss-starter/

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/YourFeature)
3. Commit your Changes (git commit -m 'Add some YourFeature')
4. Push to the Branch (git push origin feature/YourFeature)
5. Open a Pull Request

Top contributors

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• Othneil Drew for the README.md Template
• Alexandre Sanlim for the README.md badges
• Cover image