update readme, and packages

This commit is contained in:
somrat sorkar 2023-07-18 09:47:53 +06:00
parent 603478f74a
commit aafbaca2f4
3 changed files with 71 additions and 16 deletions

View File

@ -1,8 +1,8 @@
[build] [build]
publish = "public" publish = "public"
command = "yarn project-setup && yarn build" command = "yarn project-setup; yarn build"
[build.environment] [build.environment]
HUGO_VERSION = "0.115.1" HUGO_VERSION = "0.115.3"
GO_VERSION = "1.20.5" GO_VERSION = "1.20.5"
HUGO_BASEURL = "/" HUGO_BASEURL = "/"

View File

@ -1,14 +1,14 @@
{ {
"name": "hugoplate", "name": "hugoplate",
"description": "hugo tailwindcss boilerplate", "description": "hugo tailwindcss boilerplate",
"version": "1.5.0", "version": "1.5.1",
"license": "MIT", "license": "MIT",
"author": "zeon.studio", "author": "zeon.studio",
"scripts": { "scripts": {
"dev": "hugo server", "dev": "hugo server --disableFastRender",
"build": "hugo --gc --minify --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --forceSyncStatic", "build": "hugo --gc --minify --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --forceSyncStatic",
"test": "hugo server --disableFastRender --navigateToChanged --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --watch --forceSyncStatic -e production --minify", "test": "hugo server --disableFastRender --navigateToChanged --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --watch --forceSyncStatic -e production --minify",
"dev:example": "cd exampleSite; hugo server", "dev:example": "cd exampleSite; hugo server --disableFastRender",
"build:example": "cd exampleSite; hugo --gc --minify --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --forceSyncStatic", "build:example": "cd exampleSite; hugo --gc --minify --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --forceSyncStatic",
"test:example": "cd exampleSite; hugo server --disableFastRender --navigateToChanged --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --watch --forceSyncStatic -e production --minify", "test:example": "cd exampleSite; hugo server --disableFastRender --navigateToChanged --templateMetrics --templateMetricsHints --buildDrafts --buildExpired --buildFuture --watch --forceSyncStatic -e production --minify",
"update-modules": "node ./scripts/clearModules.js && hugo mod clean --all && hugo mod get -u ./... && hugo mod tidy", "update-modules": "node ./scripts/clearModules.js && hugo mod clean --all && hugo mod get -u ./... && hugo mod tidy",
@ -19,15 +19,15 @@
}, },
"devDependencies": { "devDependencies": {
"@fullhuman/postcss-purgecss": "^5.0.0", "@fullhuman/postcss-purgecss": "^5.0.0",
"@tailwindcss/forms": "^0.5.3", "@tailwindcss/forms": "^0.5.4",
"@tailwindcss/typography": "^0.5.9", "@tailwindcss/typography": "^0.5.9",
"autoprefixer": "^10.4.14", "autoprefixer": "^10.4.14",
"postcss": "^8.4.25", "postcss": "^8.4.26",
"postcss-cli": "^10.1.0", "postcss-cli": "^10.1.0",
"prettier": "^2.8.8", "prettier": "^2.8.8",
"prettier-plugin-go-template": "0.0.13", "prettier-plugin-go-template": "0.0.13",
"prettier-plugin-tailwindcss": "^0.3.0", "prettier-plugin-tailwindcss": "^0.4.1",
"tailwind-bootstrap-grid": "^5.0.1", "tailwind-bootstrap-grid": "^5.0.1",
"tailwindcss": "^3.3.2" "tailwindcss": "^3.3.3"
} }
} }

View File

@ -53,39 +53,94 @@
- 🗂️ Category Single - 🗂️ Category Single
- 🔍 Search - 🔍 Search
---
## 🚀 Getting Started ## 🚀 Getting Started
### 📦 Dependencies First you need to `clone` or `download` the template repository, and then let's get started with the following process:
- Hugo v0.115.1+ ### ⚙️ Prerequisites
To start using this template, you need to have some prerequisites installed on your machine.
- Hugo Extended v0.115+
- Node v18+ - Node v18+
- Npm v9.5+ - Npm v9.5+
- Go v1.20.5+ - Go v1.20+
### 👉 Project Setup ### 👉 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 npm run project-setup
``` ```
### 👉 Install Dependencies ### 👉 Install Dependencies
``` Install all the dependencies using the following command.
```bash
npm install npm install
``` ```
### 👉 Development Command ### 👉 Development Command
``` Start the development server using the following command.
```bash
npm run dev 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.
```bash
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.
```bash
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 ### 👉 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.
```bash
npm run build npm run build
``` ```
### 👉 Deploy Process
We have provided 4 different platform deploy platform configuration with this template, so you can deploy easily.
- Netlify
- Vercel
- Github Pages
- Gitlab Pages
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.
---
## 🐞 Reporting Issues ## 🐞 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). Its possible someone has already reported the same problem. We use GitHub Issues as the official bug tracker for this Template. Please Search [existing issues](https://github.com/zeon-studio/hugoplate/issues). Its possible someone has already reported the same problem.