chore: update doc

.gitignore

@@ -8,4 +8,25 @@
 *.html
 *.exe
 
-test_sample_data
+test_sample_data
+
+/node_modules
+/build
+.cache-loader
+
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+node_modules
+dist
+.temp
+cache
+
+.vitepress/cache

README.md

@@ -8,10 +8,11 @@
     <a href="https://codecov.io/gh/thuongtruong109/gouse"><img src="https://codecov.io/gh/thuongtruong1009/gouse/branch/main/graph/badge.svg" alt="codecov"></a>
     <a href="https://dl.circleci.com/status-badge/redirect/gh/thuongtruong109/gouse/tree/main"><img src="https://dl.circleci.com/status-badge/img/gh/thuongtruong1009/gouse/tree/main.svg?style=svg" alt="circleci"></a>
     <a href="https://pkg.go.dev/github.com/thuongtruong109/gouse"><img src="https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square" alt="go.dev"></a>
+    <a href="https://gouse.vercel.app"><img src="https://img.shields.io/badge/homepage-pink" alt="homepage_website" /></a>
     <img src="./public/count.svg" alt="gouse_functions_count">
     <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/thuongtruong109/gouse">
+    <!-- <img alt="GitHub Release" src="https://img.shields.io/github/v/release/thuongtruong109/gouse"> -->
     <!-- <a href="https://godocs.io/github.com/thuongtruong109/gouse"><img alt="Godoc" src="https://godocs.io/github.com/thuongtruong1009/gouse?status.svg"></a> -->
-    <!-- <a href="LICENSE"><img src="https://img.shields.io/github/license/thuongtruong109/gouse" alt="license"></a> -->
     <!-- <a href="https://app.codacy.com/gh/thuongtruong109/gouse/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_Coverage"><img src="https://app.codacy.com/project/badge/Coverage/21f940894abd4e0384ef8b84adc294da" alt="codacy"></a> -->
     <!-- <a href="https://sourcegraph.com/github.com/thuongtruong109/gouse?badge"><img src="https://sourcegraph.com/github.com/thuongtruong109/gouse/-/badge.svg" alt="sourcegraph"></a> -->
 </div>
@@ -61,7 +62,7 @@
 
 👉 To address that need, Gouse was created as a powerful toolkit for Go developers, a collection of built-in functions and best practices that provide comprehensive, powerful, and reliable solutions. Trusted to build services, APIs, and web applications.
 
-## 🚀 Features
+## 🚀 Module packages
 
 > Below is a list of modules that Gouse supports. This project is still in development stage, so not all features are available.
 
@@ -109,6 +110,8 @@
   </table>
 </div>
 
+* See more details at [Gouse homepage](https://gouse.vercel.app)
+
 <!-- - 
 - [ ] Auth
 - [ ] Error

cmd/doc_gen.go

@@ -121,5 +121,5 @@ func createFilePath(subPath, fileName string, result []byte) {
 }
 
 func main() {
-	GenerateDocument("docs/docs", "receipts")
+	GenerateDocument("docs", "receipts")
 }

docs/docs/.vitepress/config.ts

@@ -7,27 +7,17 @@ const pkg = require('../../package.json')
 export default defineConfig({
   lang: 'en-US',
   title: 'Gouse',
-  description: 'A modern essential Golang utility package delivering consistency, modularity, performance, & extras presets',
-
+  description: 'A modern Golang utility presets',
 
   sitemap: {
-    hostname: 'http://localhost:3000',
+    hostname: 'https://gouse.vercel.app',
   },
 
   head: [
-    [
-      'script',
-      { id: 'register-sw' },
-      `;(() => {
-        if ('serviceWorker' in navigator) {
-          navigator.serviceWorker.register('/sw.js')
-        }
-      })()`
-    ],
     [
       'favicon',
-      { rel: 'icon', type: 'image/ico', href: '/img/favicon.ico' }
-    ]
+      { rel: 'icon', type: 'image/*', href: '/img/favicon.ico' }
+    ],
   ],
 
   themeConfig: {

docs/docs/index.md

@@ -11,10 +11,10 @@ hero:
   actions:
     - theme: brand
       text: What is Gouse?
-      link: /guide/what-is-gouse
+      link: /introduction/what-is-gouse
     - theme: alt
       text: Quickstart
-      link: /guide/getting-started
+      link: /introduction/getting-started
     - theme: alt
       text: GitHub
       link: https://github.com/thuongtruong109/gouse
@@ -38,6 +38,8 @@ features:
 ---
 
 <style>
+@import './style.css';
+
 :root {
   --vp-home-hero-name-color: transparent;
   --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
@@ -57,4 +59,5 @@ features:
     --vp-home-hero-image-filter: blur(68px);
   }
 }
+
 </style>

docs/docs/style.css

@@ -0,0 +1,19 @@
+:root {
+    --vp-home-hero-name-color: transparent;
+    --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
+
+    --vp-home-hero-image-background-image: linear-gradient(-45deg, #bd34fe 50%, #47caff 50%);
+    --vp-home-hero-image-filter: blur(44px);
+  }
+
+  @media (min-width: 640px) {
+    :root {
+      --vp-home-hero-image-filter: blur(56px);
+    }
+  }
+
+  @media (min-width: 960px) {
+    :root {
+      --vp-home-hero-image-filter: blur(68px);
+    }
+  }