Skip to content
This repository was archived by the owner on Dec 8, 2024. It is now read-only.

Commit 3d2611e

Browse files
committed
2 parents 4c22cdc + cc9dd2f commit 3d2611e

File tree

1 file changed

+1
-223
lines changed

1 file changed

+1
-223
lines changed

readme.md

Lines changed: 1 addition & 223 deletions
Original file line numberDiff line numberDiff line change
@@ -1,223 +1 @@
1-
<h1 align="center">Hugo + Tailwind CSS Starter and Boilerplate</h1>
2-
3-
<p align="center">Hugoplate is a free starter template built with Hugo, and TailwindCSS, providing everything you need to jumpstart your Hugo project and save valuable time.</p>
4-
5-
<p align="center">Made with ♥ by <a href="https://zeon.studio/"> Zeon Studio</a></p>
6-
<p align=center> If you find this project useful, please give it a ⭐ to show your support.</p>
7-
8-
<h2 align="center"> <a target="_blank" href="https://hugoplate.netlify.app/" 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>
9-
</h2>
10-
11-
<p align="center">
12-
<a href="https://github.com/gohugoio/hugo/releases/tag/v0.118.2" alt="Contributors">
13-
<img src="https://img.shields.io/static/v1?label=min-HUGO-version&message=0.118.2&color=f00&logo=hugo" />
14-
</a>
15-
16-
<a href="https://github.com/zeon-studio/hugoplate/blob/main/LICENSE">
17-
<img src="https://img.shields.io/github/license/zeon-studio/hugoplate" alt="license">
18-
</a>
19-
20-
<a href="https://github.com/zeon-studio/hugoplate">
21-
<img src="https://img.shields.io/github/languages/code-size/zeon-studio/hugoplate" alt="code size">
22-
</a>
23-
24-
<a href="https://github.com/zeon-studio/hugoplate/graphs/contributors">
25-
<img src="https://img.shields.io/github/contributors/zeon-studio/hugoplate" alt="contributors">
26-
</a>
27-
</p>
28-
29-
## 🎁 What's Included
30-
31-
We have included almost everything you need to start your Hugo project. Let's see what's included in this template:
32-
33-
### 📌 Key Features
34-
35-
- 👥 Multi-Authors
36-
- 🎯 Similar Posts Suggestion
37-
- 🔍 Search Functionality
38-
- 🌑 Dark Mode
39-
- 🏷️ Tags & Categories
40-
- 🔗 Netlify setting pre-configured
41-
- 📞 Support contact form
42-
- 📱 Fully responsive
43-
- 📝 Write and update content in Markdown
44-
- 💬 Disqus Comment
45-
- 🔳 Syntax Highlighting
46-
47-
### 📄 15+ Pre-designed Pages
48-
49-
- 🏠 Homepage
50-
- 👤 About
51-
- 📞 Contact
52-
- 👥 Authors
53-
- 👤 Author Single
54-
- 📝 Blog
55-
- 📝 Blog Single
56-
- 🚫 Custom 404
57-
- 💡 Elements
58-
- 📄 Privacy Policy
59-
- 🏷️ Tags
60-
- 🏷️ Tag Single
61-
- 🗂️ Categories
62-
- 🗂️ Category Single
63-
- 🔍 Search
64-
65-
### 📦 Tech Stack
66-
67-
- [Hugo](https://gohugo.io/)
68-
- [Tailwind CSS](https://tailwindcss.com/)
69-
- [PostCSS](https://postcss.org/)
70-
- [PurgeCSS](https://purgecss.com/)
71-
- [AutoPrefixer](https://autoprefixer.github.io/)
72-
- [Hugo Modules](https://gohugo.io/hugo-modules/)
73-
- [Markdown](https://markdownguide.org/)
74-
- [Prettier](https://prettier.io/)
75-
- [Jshint](https://jshint.com/)
76-
- [Netlify](https://www.netlify.com/)
77-
- [Vercel](https://vercel.com/)
78-
- [Github Actions](https://github.com/features/actions)
79-
- [Gitlab Ci](https://docs.gitlab.com/ee/ci/)
80-
- [AWS Amplify](https://aws.amazon.com/amplify/)
81-
82-
---
83-
84-
## 🚀 Getting Started
85-
86-
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:
87-
88-
### ⚙️ Prerequisites
89-
90-
To start using this template, you need to have some prerequisites installed on your machine.
91-
92-
- [Hugo Extended v0.115+](https://gohugo.io/installation/)
93-
- [Node v18+](https://nodejs.org/en/download/)
94-
- [Go v1.20+](https://go.dev/doc/install)
95-
96-
### 👉 Project Setup
97-
98-
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.
99-
100-
```bash
101-
npm run project-setup
102-
```
103-
104-
### 👉 Install Dependencies
105-
106-
Install all the dependencies using the following command.
107-
108-
```bash
109-
npm install
110-
```
111-
112-
### 👉 Development Command
113-
114-
Start the development server using the following command.
115-
116-
```bash
117-
npm run dev
118-
```
119-
120-
### 🎬 Still Confused? Watch a Quick Video
121-
122-
https://github.com/zeon-studio/hugoplate/assets/58769763/c260c0ae-91be-42ce-b8db-aa7f11f777bd
123-
124-
---
125-
126-
## 📝 Customization
127-
128-
This template has been designed with a lot of customization options in mind. You can customize almost anything you want, including:
129-
130-
### 👉 Site Config
131-
132-
You can change the site title, base URL, language, theme, plugins, and more from the `hugo.toml` file.
133-
134-
### 👉 Site Params
135-
136-
You can customize all the parameters from the `config/_default/params.toml` file. This includes the logo, favicon, search, SEO metadata, and more.
137-
138-
### 👉 Colors and Fonts
139-
140-
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.
141-
142-
### 👉 Social Links
143-
144-
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.
145-
146-
---
147-
148-
## 🛠 Advanced Usage
149-
150-
We have added some custom scripts to make your life easier. You can use these scripts to help you with your development.
151-
152-
### 👉 Update Modules
153-
154-
We have added a lot of modules to this template. You can update all the modules using the following command.
155-
156-
```bash
157-
npm run update-modules
158-
```
159-
160-
### 👉 Remove Dark Mode
161-
162-
If you want to remove dark mode from your project, then you have 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.
163-
164-
```bash
165-
npm run remove-darkmode
166-
```
167-
168-
> **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.
169-
170-
---
171-
172-
## 🚀 Build And Deploy
173-
174-
After you finish your development, you can build or deploy your project almost everywhere. Let's see the process:
175-
176-
### 👉 Build Command
177-
178-
To build your project locally, you can use the following command. It will purge all the unused CSS and minify all the files.
179-
180-
```bash
181-
npm run build
182-
```
183-
184-
### 👉 Deploy Site
185-
186-
We have provided 5 different deploy platform configurations with this template, so you can deploy easily.
187-
188-
- [Netlify](https://www.netlify.com/)
189-
- [Vercel](https://vercel.com/)
190-
- [Github Actions](https://github.com/features/actions)
191-
- [Gitlab Ci](https://docs.gitlab.com/ee/ci/)
192-
- [AWS Amplify](https://aws.amazon.com/amplify/)
193-
194-
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.
195-
196-
> **Note:** You must change the `baseURL` in the `hugo.toml` file. Otherwise, your site will not work properly.
197-
198-
---
199-
200-
## 🔒 Guide to Staying Compliant
201-
202-
### 🐞 Reporting Issues
203-
204-
We use GitHub Issues as the official bug tracker for this Template. Please Search [existing issues](https://github.com/zeon-studio/hugoplate/issues). It’s possible someone has already reported the same problem.
205-
If your problem or idea has not been addressed yet, feel free to [open a new issue](https://github.com/zeon-studio/hugoplate/issues).
206-
207-
### 📝 License
208-
209-
Copyright (c) 2023 - Present, Designed & Developed by [Zeon Studio](https://zeon.studio/)
210-
211-
**Code License:** Released under the [MIT](https://github.com/zeon-studio/hugoplate/blob/main/LICENSE) license.
212-
213-
**Image license:** The images are only for demonstration purposes. They have their license, we don't have permission to share those images.
214-
215-
---
216-
217-
## 🖼️ Showcase
218-
219-
List of projects people are building with **Hugoplate**! Have you built a project with Hugoplate? Submit it by creating a pull request and we'll feature it here!
220-
221-
| [![Open Neuromorphic](https://tinyurl.com/hp7avtje)](https://open-neuromorphic.org/) | [![AI Models](https://tinyurl.com/mu4p7dhb)](https://aimodels.org/) | [![Hugobricks](https://tinyurl.com/4x3uwhm9)](https://www.hugobricks.preview.usecue.com/) |
222-
|:---:|:---:|:---:|
223-
| **Open Neuromorphic** | **AI Models** | **Hugobricks** |
1+
# Fusion Engine Website

0 commit comments

Comments
 (0)