docs: 优化项目文档

2024-01-14 13:49:52 +08:00
parent ea1ed6cc20
commit 83beeb43ce
85 changed files with 10959 additions and 266 deletions
--- a/examples/internal/deadlock-detect-server/README.md
+++ b/examples/internal/deadlock-detect-server/README.md
@@ -0,0 +1,27 @@
+# Main
+
+
+
+[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur/main)
+![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
+
+## 目录
+列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
+<details>
+<summary>展开 / 折叠目录</summary
+
+
+> 包级函数定义
+
+|函数|描述
+|:--|:--
+
+
+> 结构体定义
+
+|结构体|描述
+|:--|:--
+
+</details>
+
+
--- a/examples/internal/room-shunt-server/README.md
+++ b/examples/internal/room-shunt-server/README.md
@@ -0,0 +1,27 @@
+# Main
+
+
+
+[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur/main)
+![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
+
+## 目录
+列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
+<details>
+<summary>展开 / 折叠目录</summary
+
+
+> 包级函数定义
+
+|函数|描述
+|:--|:--
+
+
+> 结构体定义
+
+|结构体|描述
+|:--|:--
+
+</details>
+
+
--- a/examples/internal/simple-echo-websocket-server/README.md
+++ b/examples/internal/simple-echo-websocket-server/README.md
@@ -0,0 +1,27 @@
+# Main
+
+
+
+[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur/main)
+![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
+
+## 目录
+列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
+<details>
+<summary>展开 / 折叠目录</summary
+
+
+> 包级函数定义
+
+|函数|描述
+|:--|:--
+
+
+> 结构体定义
+
+|结构体|描述
+|:--|:--
+
+</details>
+
+
--- a/examples/internal/ticker-server/README.md
+++ b/examples/internal/ticker-server/README.md
@@ -0,0 +1,27 @@
+# Main
+
+
+
+[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur/main)
+![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
+
+## 目录
+列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
+<details>
+<summary>展开 / 折叠目录</summary
+
+
+> 包级函数定义
+
+|函数|描述
+|:--|:--
+
+
+> 结构体定义
+
+|结构体|描述
+|:--|:--
+
+</details>
+
+
--- a/examples/internal/ticker/README.md
+++ b/examples/internal/ticker/README.md
@@ -0,0 +1,27 @@
+# Main
+
+
+
+[![Go doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/kercylan98/minotaur/main)
+![](https://img.shields.io/badge/Email-kercylan@gmail.com-green.svg?style=flat)
+
+## 目录
+列出了该 `package` 下所有的函数，可通过目录进行快捷跳转 ❤️
+<details>
+<summary>展开 / 折叠目录</summary
+
+
+> 包级函数定义
+
+|函数|描述
+|:--|:--
+
+
+> 结构体定义
+
+|结构体|描述
+|:--|:--
+
+</details>
+
+