Hugoplate repo Note: Most of this is still just the hugoplate readme. -Devon

🚀 Getting Started

⚙️ Prerequisites

To start using this template, you need to have some prerequisites installed on your machine.

• Hugo Extended v0.124+
• Node v20+
• Go v1.22+

Note from Devon: You can install hugo extended with Chocolatey using an admin powershell and:

choco install hugo-extended

WARNING:

Currently build is failing due to an upstream Hugo component calling .Site.Social (should be .Params.Social), will remove this warning once latest Hugo version has fixed itself. For now, downgrading to 2nd most recent (as of writing) v0.135-1, fixes build issue.

Pacman example: (If it's in your package cache)

pacman -U file:///var/cache/pacman/pkg/package-old_version.pkg.tar.type

I will be excited when we have no external dependencies -Devon

👉 Install Dependencies

Install all the dependencies using the following command.

npm install

👉 Development Command

Start the development server using the following command.

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.

npm run update-theme

Note: This command will work after running 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.

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.

npm run remove-darkmode

Note: This command will work before running project-setup script. If you 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. It will purge all the unused CSS and minify all the files.

npm run build

👉 Deploy Site

We have provided 5 different deploy platform configurations with this template, so you can deploy easily.

• Netlify
• Vercel
• Github Actions
• Gitlab Ci
• AWS 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.

---

🔒 Guide to Staying Compliant

🐞 Reporting Issues

We use GitHub Issues as the official bug tracker for this Template. Please Search existing issues. It’s possible someone has already reported the same problem. If your problem or idea has not been addressed yet, feel free to open a new issue.

📝 License

Copyright (c) 2023 - Present, Designed & Developed by Zeon Studio

Code License: Released under the MIT 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!

Open Neuromorphic	AI Models	Hugobricks	ONO LLC

---

💻 Need Customization?

If you need a custom theme, theme customization, or complete website development services from scratch you can Hire Us.