Update README.md
parent
dfed01d167
commit
38d1f2a7c6
96
README.md
96
README.md
|
|
@ -1,90 +1,8 @@
|
|||
<h1 align="center">Hugo + Tailwind CSS Starter and Boilerplate</h1>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
</h2>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/gohugoio/hugo/releases/tag/v0.126.0" alt="Contributors">
|
||||
<img src="https://img.shields.io/static/v1?label=min-HUGO-version&message=0.126.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>
|
||||
|
||||
## 🎁 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
|
||||
|
||||
- [Hugo](https://gohugo.io/)
|
||||
- [Tailwind CSS](https://tailwindcss.com/)
|
||||
- [PostCSS](https://postcss.org/)
|
||||
- [PurgeCSS](https://purgecss.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/)
|
||||
|
||||
---
|
||||
[Hugoplate repo](https://github.com/zeon-studio/hugoplate)
|
||||
Note: Most of this is still just the hugoplate readme. -Devon
|
||||
|
||||
## 🚀 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.
|
||||
|
|
@ -93,12 +11,10 @@ To start using this template, you need to have some prerequisites installed on y
|
|||
- [Node v20+](https://nodejs.org/en/download/)
|
||||
- [Go v1.22+](https://go.dev/doc/install)
|
||||
|
||||
### 👉 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.
|
||||
|
||||
```bash
|
||||
npm run project-setup
|
||||
**Note from Devon:**
|
||||
You can install hugo extended with Chocolatey using an admin powershell and:
|
||||
```
|
||||
choco install hugo-extended
|
||||
```
|
||||
|
||||
### 👉 Install Dependencies
|
||||
|
|
|
|||
Loading…
Reference in New Issue