Skip to content

Commit

Permalink
docs: change go-gin-boilerplate to ggb
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjayheaven committed Jan 26, 2024
1 parent e50f18d commit 16f40fc
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 53 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

<img src="./assets/golang.png" align="right"/>

![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)

</div>

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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) 上赞助一杯咖啡

Expand Down
24 changes: 12 additions & 12 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

<img src="./assets/golang.png" align="right"/>

![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)

</div>

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions docs/go-gin-boilerplate/docs/guide/middleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 鉴权中间件

Expand Down
24 changes: 12 additions & 12 deletions docs/go-gin-boilerplate/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ sidebar_position: 1

<div>

<img src="/go-gin-boilerplate/img/golang.png" align="right"/>
<img src="/ggb/img/golang.png" align="right"/>

![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)

</div>

Expand Down Expand Up @@ -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
```

Expand Down Expand Up @@ -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) 上赞助一杯咖啡

Expand Down
2 changes: 1 addition & 1 deletion docs/go-gin-boilerplate/docs/start/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

### 安装依赖
Expand Down
16 changes: 8 additions & 8 deletions docs/go-gin-boilerplate/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ const config: Config = {
url: "https://sanjayheaven.github.io/",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
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",
Expand All @@ -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,
Expand Down Expand Up @@ -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",
},
Expand All @@ -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",
Expand All @@ -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",
},
],
},
Expand All @@ -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",
Expand Down
10 changes: 5 additions & 5 deletions docs/go-gin-boilerplate/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default function Home(): JSX.Element {
<img
onClick={() =>
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"
Expand All @@ -71,10 +71,10 @@ export default function Home(): JSX.Element {
<img
onClick={() =>
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"
/>
Expand All @@ -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
Expand Down Expand Up @@ -131,7 +131,7 @@ export default function Home(): JSX.Element {
>
<div>
git clone
https://github.com/sanjayheaven/go-gin-boilerplate.git
https://github.com/sanjayheaven/ggb.git
</div>
<div>cd go-gin-boilerplate </div>
<div>go mod download</div>
Expand Down

0 comments on commit 16f40fc

Please sign in to comment.