From 16f40fc5b9cda6f65c63fbd3d92231645254862e Mon Sep 17 00:00:00 2001 From: Dorvan Date: Fri, 26 Jan 2024 09:24:15 +0800 Subject: [PATCH] docs: change go-gin-boilerplate to ggb --- README.md | 24 +++++++++---------- README_en.md | 24 +++++++++---------- .../docs/guide/middleware.md | 6 ++--- docs/go-gin-boilerplate/docs/intro.md | 24 +++++++++---------- docs/go-gin-boilerplate/docs/start/install.md | 2 +- docs/go-gin-boilerplate/docusaurus.config.ts | 16 ++++++------- docs/go-gin-boilerplate/src/pages/index.tsx | 10 ++++---- 7 files changed, 53 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 90b8423..dbfb9c6 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ -![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sanjayheaven/go-gin-boilerplate) -![CI](https://github.com/sanjayheaven/go-gin-boilerplate/workflows/Go/badge.svg) -![License](https://img.shields.io/github/license/sanjayheaven/go-gin-boilerplate) +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sanjayheaven/ggb) +![CI](https://github.com/sanjayheaven/ggb/workflows/Go/badge.svg) +![License](https://img.shields.io/github/license/sanjayheaven/ggb) ## 📘 Documents -- [项目文档](https://sanjayheaven.github.io/go-gin-boilerplate/) -- [Swagger 接口文档](https://go-gin-boilerplate.gganbu.services/swagger/index.html) +- [项目文档](https://sanjayheaven.github.io/ggb/) +- [Swagger 接口文档](https://ggb.gganbu.services/swagger/index.html) @@ -53,8 +53,8 @@ ## 🚀 快速开始 ```sh -git clone https://github.com/sanjayheaven/go-gin-boilerplate.git -cd go-gin-boilerplate +git clone https://github.com/sanjayheaven/ggb.git +cd ggb go mod download ``` @@ -133,13 +133,13 @@ docker compose up -d ## 🤝 支持 - Star 🌟 项目 -- 欢迎提交 [issue](https://github.com/sanjayheaven/go-gin-boilerplate/issues)。感谢您的支持 +- 欢迎提交 [issue](https://github.com/sanjayheaven/ggb/issues)。感谢您的支持 - 帮助在社交媒体上宣传并向朋友推荐它 - [![Twitter](https://img.shields.io/twitter/url?label=Twitter&logo=twitter&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![Facebook](https://img.shields.io/twitter/url?label=Facebook&logo=facebook&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![WhatsApp](https://img.shields.io/twitter/url?label=WhatsApp&logo=whatsapp&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://api.whatsapp.com/send?text=Wow:%20https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![Telegram](https://img.shields.io/twitter/url?label=Telegram&logo=telegram&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) + [![Twitter](https://img.shields.io/twitter/url?label=Twitter&logo=twitter&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![Facebook](https://img.shields.io/twitter/url?label=Facebook&logo=facebook&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![WhatsApp](https://img.shields.io/twitter/url?label=WhatsApp&logo=whatsapp&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://api.whatsapp.com/send?text=Wow:%20https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![Telegram](https://img.shields.io/twitter/url?label=Telegram&logo=telegram&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) - 你也可以在 [Ko-Fi](https://ko-fi.com/dorvan) 或者 [Buy Me A Coffee](https://www.buymeacoffee.com/dorvan) 上赞助一杯咖啡 diff --git a/README_en.md b/README_en.md index b811937..e09490c 100644 --- a/README_en.md +++ b/README_en.md @@ -4,14 +4,14 @@ -![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sanjayheaven/go-gin-boilerplate) -![CI](https://github.com/sanjayheaven/go-gin-boilerplate/workflows/Go/badge.svg) -![License](https://img.shields.io/github/license/sanjayheaven/go-gin-boilerplate) +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sanjayheaven/ggb) +![CI](https://github.com/sanjayheaven/ggb/workflows/Go/badge.svg) +![License](https://img.shields.io/github/license/sanjayheaven/ggb) ## 📘 Documents -- [Project Document](https://sanjayheaven.github.io/go-gin-boilerplate/) -- [Swagger Api Document](https://go-gin-boilerplate.gganbu.services/swagger/index.html) +- [Project Document](https://sanjayheaven.github.io/ggb/) +- [Swagger Api Document](https://ggb.gganbu.services/swagger/index.html) @@ -50,8 +50,8 @@ A development boilerplate based on the Gin framework, aimed at helping developer ## 🚀 Quick Start ```sh -git clone https://github.com/sanjayheaven/go-gin-boilerplate.git -cd go-gin-boilerplate +git clone https://github.com/sanjayheaven/ggb.git +cd ggb go mod download ``` @@ -137,13 +137,13 @@ docker compose up -d ## 🤝 Support - Star 🌟 the project -- Welcome to submit [issue](https://github.com/sanjayheaven/go-gin-boilerplate/issues). Thank you for your support +- Welcome to submit [issue](https://github.com/sanjayheaven/ggb/issues). Thank you for your support - Help promote it on social media and recommend it to friends - [![Twitter](https://img.shields.io/twitter/url?label=Twitter&logo=twitter&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![Facebook](https://img.shields.io/twitter/url?label=Facebook&logo=facebook&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![WhatsApp](https://img.shields.io/twitter/url?label=WhatsApp&logo=whatsapp&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://api.whatsapp.com/send?text=Wow:%20https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![Telegram](https://img.shields.io/twitter/url?label=Telegram&logo=telegram&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) + [![Twitter](https://img.shields.io/twitter/url?label=Twitter&logo=twitter&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![Facebook](https://img.shields.io/twitter/url?label=Facebook&logo=facebook&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![WhatsApp](https://img.shields.io/twitter/url?label=WhatsApp&logo=whatsapp&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://api.whatsapp.com/send?text=Wow:%20https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![Telegram](https://img.shields.io/twitter/url?label=Telegram&logo=telegram&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) - You can also sponsor a cup of coffee on [Ko-Fi](https://ko-fi.com/dorvan) or [Buy Me A Coffee](https://www.buymeacoffee.com/dorvan) diff --git a/docs/go-gin-boilerplate/docs/guide/middleware.md b/docs/go-gin-boilerplate/docs/guide/middleware.md index cbaed2b..189be81 100644 --- a/docs/go-gin-boilerplate/docs/guide/middleware.md +++ b/docs/go-gin-boilerplate/docs/guide/middleware.md @@ -54,9 +54,9 @@ func init() { ## 目前已有的中间件 -- [JWT 鉴权中间件](https://github.com/sanjayheaven/go-gin-boilerplate/tree/main/internal/middlewares/jwt.go) -- [跨域中间件](https://github.com/sanjayheaven/go-gin-boilerplate/blob/main/internal/middlewares/cors.go) -- [错误处理中间件](https://github.com/sanjayheaven/go-gin-boilerplate/blob/main/internal/middlewares/errorHandle.go) +- [JWT 鉴权中间件](https://github.com/sanjayheaven/ggb/tree/main/internal/middlewares/jwt.go) +- [跨域中间件](https://github.com/sanjayheaven/ggb/blob/main/internal/middlewares/cors.go) +- [错误处理中间件](https://github.com/sanjayheaven/ggb/blob/main/internal/middlewares/errorHandle.go) ### JWT 鉴权中间件 diff --git a/docs/go-gin-boilerplate/docs/intro.md b/docs/go-gin-boilerplate/docs/intro.md index c1b9ef3..d5b2c70 100644 --- a/docs/go-gin-boilerplate/docs/intro.md +++ b/docs/go-gin-boilerplate/docs/intro.md @@ -6,13 +6,13 @@ sidebar_position: 1
- + -![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sanjayheaven/go-gin-boilerplate) -![CI](https://github.com/sanjayheaven/go-gin-boilerplate/workflows/Go/badge.svg) -![License](https://img.shields.io/github/license/sanjayheaven/go-gin-boilerplate) +![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sanjayheaven/ggb) +![CI](https://github.com/sanjayheaven/ggb/workflows/Go/badge.svg) +![License](https://img.shields.io/github/license/sanjayheaven/ggb) -[Swagger 接口文档](https://go-gin-boilerplate.gganbu.services/swagger/index.html) +[Swagger 接口文档](https://ggb.gganbu.services/swagger/index.html)
@@ -47,8 +47,8 @@ sidebar_position: 1 ## 快速开始 ```sh -git clone https://github.com/sanjayheaven/go-gin-boilerplate.git -cd go-gin-boilerplate +git clone https://github.com/sanjayheaven/ggb.git +cd ggb go mod download ``` @@ -127,13 +127,13 @@ docker compose up -d ## 支持 🫶 - Star 🌟 项目 -- 欢迎提交 [issue](https://github.com/sanjayheaven/go-gin-boilerplate/issues)。感谢您的支持 +- 欢迎提交 [issue](https://github.com/sanjayheaven/ggb/issues)。感谢您的支持 - 帮助在社交媒体上宣传并向朋友推荐它 - [![Twitter](https://img.shields.io/twitter/url?label=Twitter&logo=twitter&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![Facebook](https://img.shields.io/twitter/url?label=Facebook&logo=facebook&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![WhatsApp](https://img.shields.io/twitter/url?label=WhatsApp&logo=whatsapp&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://api.whatsapp.com/send?text=Wow:%20https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) - [![Telegram](https://img.shields.io/twitter/url?label=Telegram&logo=telegram&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fgo-gin-boilerplate) + [![Twitter](https://img.shields.io/twitter/url?label=Twitter&logo=twitter&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![Facebook](https://img.shields.io/twitter/url?label=Facebook&logo=facebook&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![WhatsApp](https://img.shields.io/twitter/url?label=WhatsApp&logo=whatsapp&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://api.whatsapp.com/send?text=Wow:%20https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) + [![Telegram](https://img.shields.io/twitter/url?label=Telegram&logo=telegram&style=flat&url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb)](https://t.me/share/url?url=https%3A%2F%2Fgithub.com%2Fsanjayheaven%2Fggb) - 你也可以在 [Ko-Fi](https://ko-fi.com/dorvan) 或者 [Buy Me A Coffee](https://www.buymeacoffee.com/dorvan) 上赞助一杯咖啡 diff --git a/docs/go-gin-boilerplate/docs/start/install.md b/docs/go-gin-boilerplate/docs/start/install.md index 6694e8c..1a2787d 100644 --- a/docs/go-gin-boilerplate/docs/start/install.md +++ b/docs/go-gin-boilerplate/docs/start/install.md @@ -15,7 +15,7 @@ sidebar_position: 1 ### 克隆项目 ```sh -git clone https://github.com/sanjayheaven/go-gin-boilerplate.git +git clone https://github.com/sanjayheaven/ggb.git ``` ### 安装依赖 diff --git a/docs/go-gin-boilerplate/docusaurus.config.ts b/docs/go-gin-boilerplate/docusaurus.config.ts index fcba6f8..d9ace91 100644 --- a/docs/go-gin-boilerplate/docusaurus.config.ts +++ b/docs/go-gin-boilerplate/docusaurus.config.ts @@ -13,12 +13,12 @@ const config: Config = { url: "https://sanjayheaven.github.io/", // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: "/go-gin-boilerplate/", + baseUrl: "/ggb/", // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. organizationName: "sanjayheaven", // Usually your GitHub org/user name. - projectName: "go-gin-boilerplate", // Usually your repo name. + projectName: "ggb", // Usually your repo name. onBrokenLinks: "ignore", onBrokenMarkdownLinks: "warn", @@ -41,7 +41,7 @@ const config: Config = { // showLastUpdateAuthor: true, // Please change this to your repo. // Remove this to remove the "edit this page" links. - // editUrl: "https://github.com/sanjayheaven/go-gin-boilerplate/issure", + // editUrl: "https://github.com/sanjayheaven/ggb/issure", }, blog: { showReadingTime: true, @@ -99,7 +99,7 @@ const config: Config = { position: "right", items: [ { - href: "https://github.com/sanjayheaven/go-gin-boilerplate", + href: "https://github.com/sanjayheaven/ggb", label: "🌟 Star on GitHub", target: "_blank", }, @@ -114,14 +114,14 @@ const config: Config = { target: "_blank", }, { - href: "https://github.com/sanjayheaven/go-gin-boilerplate/issues/new", + href: "https://github.com/sanjayheaven/ggb/issues/new", label: "🆙 Help Improve", target: "_blank", }, ], }, { - href: "https://github.com/sanjayheaven/go-gin-boilerplate", + href: "https://github.com/sanjayheaven/ggb", position: "right", className: "header-github-link", "aria-label": "GitHub repository", @@ -137,7 +137,7 @@ const config: Config = { { label: "Tutorial", to: "/docs/intro" }, { label: "Swagger", - to: "https://go-gin-boilerplate.gganbu.services/swagger/index.html", + to: "https://ggb.gganbu.services/swagger/index.html", }, ], }, @@ -146,7 +146,7 @@ const config: Config = { items: [ { label: "GitHub", - href: "https://github.com/sanjayheaven/go-gin-boilerplate", + href: "https://github.com/sanjayheaven/ggb", }, // { // label: "Discord", diff --git a/docs/go-gin-boilerplate/src/pages/index.tsx b/docs/go-gin-boilerplate/src/pages/index.tsx index 29629af..60a4337 100644 --- a/docs/go-gin-boilerplate/src/pages/index.tsx +++ b/docs/go-gin-boilerplate/src/pages/index.tsx @@ -60,7 +60,7 @@ export default function Home(): JSX.Element { window.open( - "https://github.com/sanjayheaven/go-gin-boilerplate" + "https://github.com/sanjayheaven/ggb" ) } src="https://img.shields.io/github/stars/sanjayheaven/go-gin-boilerplate" @@ -71,10 +71,10 @@ export default function Home(): JSX.Element { window.open( - "https://github.com/sanjayheaven/go-gin-boilerplate" + "https://github.com/sanjayheaven/ggb" ) } - src="https://github.com/sanjayheaven/go-gin-boilerplate/workflows/Go/badge.svg" + src="https://github.com/sanjayheaven/ggb/workflows/Go/badge.svg" alt="" className=" h-6 cursor-pointer" /> @@ -97,7 +97,7 @@ export default function Home(): JSX.Element { transition-all duration-300 bg-white rounded-md text-black no-underline min-w-[170px] sm:min-w-max text-center" onClick={() => - window.open("https://github.com/sanjayheaven/go-gin-boilerplate") + window.open("https://github.com/sanjayheaven/ggb") } > GitHub @@ -131,7 +131,7 @@ export default function Home(): JSX.Element { >
git clone - https://github.com/sanjayheaven/go-gin-boilerplate.git + https://github.com/sanjayheaven/ggb.git
cd go-gin-boilerplate
go mod download