hugoplate
<h1 align="center">Hugo + Tailwind CSS Starter and Boilerplate</h1> <p align="center">Hugoplate is a free starter template built with Hugo and Tailwind CSS v4.0, providing everything you need to jumpstart your Hugo project and save valuable time.</p> <p align="center">Made with β₯ by <a href="https://zeon.studio/"> Zeon Studio</a></p> <p align=center> If you find this project useful, please give it a β to show your support.</p> <h2 align="center"> <a target="_blank" href="https://zeon.studio/preview?project=hugoplate" rel="nofollow">π Demo</a> | <a target="_blank" href="https://pagespeed.web.dev/analysis/https-hugoplate-netlify-app/6lyxjw6t4r?form_factor=desktop">Page Speed (95+)π</a> | <a target="_blank" href="https://app.sitepins.com/new/clone?name=Hugoplate&repository=https://github.com/zeon-studio/hugoplate?aff=hugoplate"> <img src="https://sitepins.com/button.svg" alt="One Click Deploy With Sitepins"> </a> </h2> <p align="center"> <a href="https://github.com/gohugoio/hugo/releases/tag/v0.158.0" alt="Contributors"> <img alt="hugo version" src="https://img.shields.io/static/v1?label=min-HUGO-version&message=0.158.0&color=f00&logo=hugo" /> </a> <a href="https://github.com/zeon-studio/hugoplate/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/zeon-studio/hugoplate" alt="license"> </a> <a href="https://github.com/zeon-studio/hugoplate"> <img src="https://img.shields.io/github/languages/code-size/zeon-studio/hugoplate" alt="code size"> </a> <a href="https://github.com/zeon-studio/hugoplate/graphs/contributors"> <img src="https://img.shields.io/github/contributors/zeon-studio/hugoplate" alt="contributors"> </a> </p> ## Table of Contents - [What's Included](#-whats-included) - [Key Features](#-key-features) - [15+ Pre-designed Pages](#-15-pre-designed-pages) - [Tech Stack](#-tech-stack) - [Getting Started](#-getting-started) - [Prerequisites](#-prerequisites) - [Project Setup](#-project-setup) - [Install Dependencies](#-install-dependencies) - [Development Command](#-development-command) - [Customization](#-customization) - [Site Config](#-site-config) - [Site Params](#-site-params) - [Colors and Fonts](#-colors-and-fonts) - [Social Links](#-social-links) - [Advanced Usage](#-advanced-usage) - [Build And Deploy](#-build-and-deploy) - [Guide to Staying Compliant](#-guide-to-staying-compliant) - [Showcase](#-showcase) - [Need Customization?](#-need-customization) ## π What's Included We have included almost everything you need to start your Hugo project. Let's see what's included in this template: ### π Key Features - π₯ Multi-Authors - π― Similar Posts Suggestion - π Search Functionality - π Dark Mode - π·οΈ Tags & Categories - π Netlify setting pre-configured - π Support contact form - π± Fully responsive - π Write and update content in Markdown - π¬ Open-Remark Comment - π³ Syntax Highlighting ### π 15+ Pre-designed Pages - π Homepage - π€ About - π Contact - π₯ Authors - π€ Author Single - π Blog - π Blog Single - π« Custom 404 - π‘ Elements - π Privacy Policy - π·οΈ Tags - π·οΈ Tag Single - ποΈ Categories - ποΈ Category Single - π Search ### π¦ Tech Stack - [Hugo](https://gohugo.io/) - [Tailwind CSS v4.0](https://tailwindcss.com/) - [AutoPrefixer](https://autoprefixer.github.io/) - [Hugo Modules](https://gohugo.io/hugo-modules/) by [Gethugothemes](https://gethugothemes.com/hugo-modules) - [Markdown](https://markdownguide.org/) - [Prettier](https://prettier.io/) - [Jshint](https://jshint.com/) - [Netlify](https://www.netlify.com/) - [Vercel](https://vercel.com/) - [Github Actions](https://github.com/features/actions) - [Gitlab Ci](https://docs.gitlab.com/ee/ci/) - [AWS Amplify](https://aws.amazon.com/amplify/) --- ## π Getting Started First you need to [clone](https://github.com/zeon-studio/hugoplate) or [download](https://github.com/zeon-studio/hugoplate/archive/refs/heads/main.zip) the template repository, and then let's get started with the following process: ### β Prerequisites To start using this template, you need to have some prerequisites installed on your machine. - [Hugo Extended v0.144+](https://gohugo.io/installation/) - [Node v22+](https://nodejs.org/en/download/) - [Go v1.24+](https://go.dev/doc/install) ### π Project Setup We built this custom script to make your project setup easier. It will create a new Hugo theme folder and clone the Hugoplate theme into it. Then move the exampleSite folder into the root directory. So that you can start your Hugo server without going into the exampleSite folder. Use the following command to setup your project. ```bash npm run project-setup ``` ### π Install Dependencies Install all the dependencies using the following command. ```bash npm install ``` ### π Development Command Start the development server using the following command. ```bash npm run dev ``` ### π¬ Still Confused? Watch a Quick Video https://github.com/zeon-studio/hugoplate/assets/58769763/c260c0ae-91be-42ce-b8db-aa7f11f777bd --- ## π Customization This template has been designed with a lot of customization options in mind. You can customize almost anything you want, including: ### π Site Config You can change the site title, base URL, language, theme, plugins, and more from the `hugo.toml` file. ### π Site Params You can customize all the parameters from the `config/_default/params.toml` file. This includes the logo, favicon, search, SEO metadata, and more. ### π Colors and Fonts You can change the colors and fonts from the `data/theme.json` file. This includes the primary color, secondary color, font family, and font size. ### π Social Links You can change the social links from the `data/social.json` file. Add your social links here, and they will automatically be displayed on the site. --- ## π Advanced Usage We have added some custom scripts to make your life easier. You can use these scripts to help you with your development. ### π Update Theme If you want to update the theme, then you can use the following command. It will update the theme to the latest version. ```bash npm run update-theme ``` > **Note:** This command will work after running the `project-setup` script. ### π Update Modules We have added a lot of modules to this template. You can update all the modules using the following command. ```bash npm run update-modules ``` ### π Remove Dark Mode If you want to remove dark mode from your project, you can use the following command to remove dark mode from your project. ```bash npm run remove-darkmode ``` > **Note:** This command will work before running the `project-setup` script. If you have already run the `project-setup` command, then you have to run `npm run theme-setup` first, and then you can run this command. Afterward, you can run `npm run project-setup` again. ### π Remove Multilingual If you want to remove multilingual from your project, you can use the following command to remove multilingual from your project. ```bash npm run remove-multilang ``` > **Note:** This command will work before running the `project-setup` script. If you have already run the `project-setup` command, then you have to run `npm run theme-setup` first, and then you can run this command. Afterward, you can run `npm run project-setup` again. --- ## π Build And Deploy After you finish your development, you can build or deploy your project almost everywhere. Let's see the process: ### π Build Command To build your project locally, you can use the following command. ```bash npm run build ``` ### π Deploy Site We have provided 5 different deploy platform configurations with this template, so you can deploy easily. - [Netlify](https://www.netlify.com/) - [Vercel](https://vercel.com/) - [Github Actions](https://github.com/features/actions) - [Gitlab Ci](https://docs.gitlab.com/ee/ci/) - [AWS Amplify](https://aws.amazon.com/amplify/) And if you want to host some other hosting platforms. Then you can build your project, and you will get a `public` folder. that you can copy and paste on your hosting platform. > **Note:** You must change the `baseURL` in the `hugo.toml` file. Otherwise, your site will not work properly. --- <!-- edit with sitepins --> ## π Edit Content with CMS This template comes pre-configured with [**Sitepins**](https://sitepins.com?aff=hugoplate), a Git-based Headless CMS designed for seamless content management. You can update your websiteβs text, images, and configuration without touching a single line of code. **How to get started:** Click the Edit with Sitepins button below and follow the on-screen instructions to start editing your content visually. <a target="_blank" href="https://app.sitepins.com/new/clone?name=Hugoplate&repository=https://github.com/zeon-studio/hugoplate?aff=hugoplate"> <img src="https://sitepins.com/button.svg" alt="Edit with Sitepins"> </a> ## π Guide to Staying Compliant ### π Reporting Issues We use GitHub Issues as the official bug tracker for this Template. Please search [existing issues](https://github.com/zeon-studio/hugoplate/issues). Someone may have already reported the same problem. If your problem or idea has not been addressed yet, feel free to [open a new issue](https://github.com/zeon-studio/hugoplate/issues). ### π License Copyright (c) 2023 - Present, Designed & Developed by [Zeon Studio](https://zeon.studio/) **Code License:** Released under the [MIT](https://github.com/zeon-studio/hugoplate/blob/main/LICENSE) license. **Image license:** The images are only for demonstration purposes. They have their license, we don't have permission to share those images. --- ## π Showcase List of some projects people are building with [**Hugoplate**!](https://github.com/zeon-studio/hugoplate/discussions/207) Don't forget to add yours. --- ## π» Need Customization? If you need a custom theme, theme customization, or complete website development services from scratch, you can [Hire Us](https://zeon.studio/estimate-project).