https://github.com/odhyp/hugo-tailwindcss-starter
Starter project for Hugo and TailwindCSS v4.0, ready to deploy in Vercel :sunglasses:
https://github.com/odhyp/hugo-tailwindcss-starter
boilerplate hugo hugo-template hugo-theme starter starter-project starter-template tailwind-css tailwindcss tailwindcss-v4 vercel vercel-deployment
Last synced: 8 months ago
JSON representation
Starter project for Hugo and TailwindCSS v4.0, ready to deploy in Vercel :sunglasses:
- Host: GitHub
- URL: https://github.com/odhyp/hugo-tailwindcss-starter
- Owner: odhyp
- License: mit
- Created: 2024-09-26T03:40:22.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-03T07:56:01.000Z (over 1 year ago)
- Last Synced: 2025-02-07T02:15:01.470Z (over 1 year ago)
- Topics: boilerplate, hugo, hugo-template, hugo-theme, starter, starter-project, starter-template, tailwind-css, tailwindcss, tailwindcss-v4, vercel, vercel-deployment
- Language: HTML
- Homepage: https://hugo-tailwindcss-starter.vercel.app
- Size: 143 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Stargazers][stars-shield]][stars-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
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](https://gohugo.io/installation/) (Extended Edition - at least v0.146.x)
- [Node.js](https://nodejs.org/en/download) (at least v18.x)
- For deployment (optional):
- [Vercel Account](https://vercel.com/signup) or
- [Netlify Account](https://app.netlify.com/signup)
- [GitHub Account](https://github.com/signup)
To get a local copy up and running, follow these steps:
1. Clone the repository
```bash
git clone https://github.com/odhyp/hugo-tailwindcss-starter.git
```
2. Navigate to the project directory
```bash
cd hugo-tailwindcss-starter
```
3. Install the Node.js dependencies
```bash
npm install
```
4. Run the development server
```bash
npm run dev
```
5. When development is complete, build the optimized Hugo site
```bash
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](https://github.com/odhyp/hugo-tailwindcss-starter/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](https://gohugo.io/host-and-deploy/host-on-github-pages/) the [deployment workflow file](.github/workflows/deployment-github-pages.yml).
1. If you forked this repo in GitHub, [allow GitHub actions](https://github.com/deining/hugo-tailwindcss-starter/settings/actions) for your forked repo.
1. 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`](https://github.com/odhyp/hugo-tailwindcss-starter/blob/master/LICENSE) for more information.
## Acknowledgements
- [Othneil Drew](https://github.com/othneildrew) for the [README.md Template](https://github.com/othneildrew/Best-README-Template)
- [Alexandre Sanlim](https://github.com/alexandresanlim) for the [README.md badges](https://github.com/alexandresanlim/Badges4-README.md-Profile)
- [Cover image](https://upload.wikimedia.org/wikipedia/commons/a/af/Logo_of_Hugo_the_static_website_generator.svg)
[contributors-shield]: https://img.shields.io/github/contributors/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[contributors-url]: https://github.com/odhyp/hugo-tailwindcss-starter/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[forks-url]: https://github.com/odhyp/hugo-tailwindcss-starter/network/members
[stars-shield]: https://img.shields.io/github/stars/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[stars-url]: https://github.com/odhyp/hugo-tailwindcss-starter/stargazers
[issues-shield]: https://img.shields.io/github/issues/odhyp/hugo-tailwindcss-starter.svg?style=for-the-badge
[issues-url]: https://github.com/odhyp/hugo-tailwindcss-starter/issues