somrat sorkar 8e771a89b4 update readme

2023-07-18 12:30:34 +06:00

5.6 KiB

Executable File

Raw Blame History

Hugo + Tailwind CSS Starter and Boilerplate

Hugoplate is a free starter template built with Hugo, and TailwindCSS, providing everything you need to jumpstart your Hugo project and save valuable time.

Made with ♥ by Zeon Studio

👀 Demo | Page Speed (95+)🚀

code size

🎁 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
💬 Disqus 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

🚀 Getting Started

First you need to clone or download 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.115+
Node v18+
Npm v9.5+
Go v1.20+

👉 Project Setup

We build 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.

npm run project-setup

👉 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

🛠 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 Modules

We have added a lot of modules into 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, then you had to do it manually from everywhere. So we build a custom script to do it for you. you can use the following command to remove dark mode from your project.

npm run remove-darkmode

🚀 Build And Deploy

After you finish your development, you can build or deploy your project to 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 Process

We have provided 4 different platform deploy platform configuration with this template, so you can deploy easily.

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.

🔒 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

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.

5.6 KiB Executable File Raw Blame History Unescape Escape