generated from google/docsy-example
-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
339 lines (332 loc) · 16.1 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
site_name: rk-boot
site_url: https://rkdocs.mofcloud.com
repo_name: rookie-ninja/rk-docs
repo_url: https://github.com/rookie-ninja/rk-docs
theme:
name: material
language: en
features:
- navigation.tracking
- navigation.top
- navigation.tabs
plugins:
- glightbox
- search
- i18n:
languages:
- locale: en
name: English
build: true
default: true
- locale: zh
name: 简体中文
build: true
nav_translations:
Overview: 概览
Example: 例子
Contribution: 贡献
Guide: 指引
Code of conduct: 贡献者公约
Getting started: 快速开始
Web Framework: Web 框架
Cache: 缓存
Local: 本地缓存
Database: 数据库
Plugins: 插件
User guide: 用户指南
Common API: 通用 API
Auth: 权限
API Docs: API 文档
Prometheus client: Prometheus 客户端
Middleware: 中间件
Plugin: 插件
Logging: 日志
Tracing: 调用链
Ratelimit: 限速
Timeout: 超时
Gzip: 压缩
Config: 参数配置
Embed: 嵌入式参数
Environment variable: 环境变量
Error type: 错误码管理
App info: 应用信息
Log: 日志管理
Multiple entries: 启动多个服务
Override boot: 覆盖启动参数
Graceful shutdown: 优雅关闭
Static file handler: 静态文件管理
Trace with logs: 日志调用链
File upload: 文件上传
Compile proto: 编译 proto
Custom route: 自定义路径
Developer guide: 开发者指南
markdown_extensions:
- attr_list
- toc:
permalink: "#"
- admonition
- footnotes
- pymdownx.details
- pymdownx.superfences
- md_in_html
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
- 'Overview': 'index.md'
- 'Example': 'example/index.md'
- 'Getting started':
- 'Web Framework':
- 'gin-gonic/gin': 'getting-started/web/gin.md'
- 'gRPC': 'getting-started/web/grpc.md'
- 'labstack/echo': 'getting-started/web/echo.md'
- 'gogf/gf': 'getting-started/web/gf.md'
- 'gofiber/fiber': 'getting-started/web/fiber.md'
- 'gorilla/mux': 'getting-started/web/mux.md'
- 'zeromicro/go-zero': 'getting-started/web/zero.md'
- 'Cache':
- 'Local': 'getting-started/cache/local.md'
- 'Redis': 'getting-started/cache/redis.md'
- 'Database':
- 'MySQL': 'getting-started/database/mysql.md'
- 'PostgreSQL': 'getting-started/database/postgres.md'
- 'Redis': 'getting-started/database/redis.md'
- 'SQLite': 'getting-started/database/sqlite.md'
- 'SqlServer': 'getting-started/database/sqlserver.md'
- 'MongoDB': 'getting-started/database/mongodb.md'
- 'ClickHouse': 'getting-started/database/clickhouse.md'
- 'User guide':
- 'Web Framework':
- 'gin-gonic/gin':
- 'Swagger UI': 'user-guide/web/gin/sw.md'
- 'Common API': 'user-guide/web/gin/common.md'
- 'API Docs': 'user-guide/web/gin/doc.md'
- 'PPROF': 'user-guide/web/gin/pprof.md'
- 'Prometheus client': 'user-guide/web/gin/prom.md'
- 'Config': 'user-guide/web/gin/config.md'
- 'Embed': 'user-guide/web/gin/embed.md'
- 'Environment variable': 'user-guide/web/gin/env.md'
- 'Error type': 'user-guide/web/gin/error-type.md'
- 'App info': 'user-guide/web/gin/info.md'
- 'Log': 'user-guide/web/gin/logging.md'
- 'Multiple entries': 'user-guide/web/gin/multiple-entries.md'
- 'Override boot': 'user-guide/web/gin/override.md'
- 'Graceful shutdown': 'user-guide/web/gin/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/gin/static-file-handler.md'
- 'TLS': 'user-guide/web/gin/tls.md'
- 'Trace with logs': 'user-guide/web/gin/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/gin/mid/auth.md'
- 'Logging': 'user-guide/web/gin/mid/logging.md'
- 'Prometheus': 'user-guide/web/gin/mid/prom.md'
- 'Tracing': 'user-guide/web/gin/mid/tracing.md'
- 'RequestId': 'user-guide/web/gin/mid/meta.md'
- 'Ratelimit': 'user-guide/web/gin/mid/ratelimit.md'
- 'Timeout': 'user-guide/web/gin/mid/timeout.md'
- 'Gzip': 'user-guide/web/gin/mid/gzip.md'
- 'JWT': 'user-guide/web/gin/mid/jwt.md'
- 'CORS': 'user-guide/web/gin/mid/cors.md'
- 'Secure': 'user-guide/web/gin/mid/secure.md'
- 'CSRF': 'user-guide/web/gin/mid/csrf.md'
- 'gRPC':
- 'Swagger UI': 'user-guide/web/grpc/sw.md'
- 'Common API': 'user-guide/web/grpc/common.md'
- 'API Docs': 'user-guide/web/grpc/doc.md'
- 'gRPC gateway': 'user-guide/web/grpc/gateway.md'
- 'Compile proto': 'user-guide/web/grpc/buf.md'
- 'Custom route': 'user-guide/web/grpc/custom-route.md'
- 'PPROF': 'user-guide/web/grpc/pprof.md'
- 'Prometheus client': 'user-guide/web/grpc/prom.md'
- 'Config': 'user-guide/web/grpc/config.md'
- 'Embed': 'user-guide/web/grpc/embed.md'
- 'Environment variable': 'user-guide/web/grpc/env.md'
- 'Error type': 'user-guide/web/grpc/error-type.md'
- 'App info': 'user-guide/web/grpc/info.md'
- 'Log': 'user-guide/web/grpc/logging.md'
- 'Multiple entries': 'user-guide/web/grpc/multiple-entries.md'
- 'Override boot': 'user-guide/web/grpc/override.md'
- 'Graceful shutdown': 'user-guide/web/grpc/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/grpc/static-file-handler.md'
- 'TLS': 'user-guide/web/grpc/tls.md'
- 'File upload': 'user-guide/web/grpc/file-upload.md'
- 'Trace with logs': 'user-guide/web/grpc/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/grpc/mid/auth.md'
- 'Logging': 'user-guide/web/grpc/mid/logging.md'
- 'Prometheus': 'user-guide/web/grpc/mid/prom.md'
- 'Tracing': 'user-guide/web/grpc/mid/tracing.md'
- 'RequestId': 'user-guide/web/grpc/mid/meta.md'
- 'Ratelimit': 'user-guide/web/grpc/mid/ratelimit.md'
- 'Timeout': 'user-guide/web/grpc/mid/timeout.md'
- 'JWT': 'user-guide/web/grpc/mid/jwt.md'
- 'CORS': 'user-guide/web/grpc/mid/cors.md'
- 'Secure': 'user-guide/web/grpc/mid/secure.md'
- 'CSRF': 'user-guide/web/grpc/mid/csrf.md'
- 'labstack/echo':
- 'Swagger UI': 'user-guide/web/echo/sw.md'
- 'Common API': 'user-guide/web/echo/common.md'
- 'API Docs': 'user-guide/web/echo/doc.md'
- 'PPROF': 'user-guide/web/echo/pprof.md'
- 'Prometheus client': 'user-guide/web/echo/prom.md'
- 'Config': 'user-guide/web/echo/config.md'
- 'Embed': 'user-guide/web/echo/embed.md'
- 'Environment variable': 'user-guide/web/echo/env.md'
- 'Error type': 'user-guide/web/echo/error-type.md'
- 'App info': 'user-guide/web/echo/info.md'
- 'Log': 'user-guide/web/echo/logging.md'
- 'Multiple entries': 'user-guide/web/echo/multiple-entries.md'
- 'Override boot': 'user-guide/web/echo/override.md'
- 'Graceful shutdown': 'user-guide/web/echo/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/echo/static-file-handler.md'
- 'TLS': 'user-guide/web/echo/tls.md'
- 'Trace with logs': 'user-guide/web/echo/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/echo/mid/auth.md'
- 'Logging': 'user-guide/web/echo/mid/logging.md'
- 'Prometheus': 'user-guide/web/echo/mid/prom.md'
- 'Tracing': 'user-guide/web/echo/mid/tracing.md'
- 'RequestId': 'user-guide/web/echo/mid/meta.md'
- 'Ratelimit': 'user-guide/web/echo/mid/ratelimit.md'
- 'Timeout': 'user-guide/web/echo/mid/timeout.md'
- 'Gzip': 'user-guide/web/echo/mid/gzip.md'
- 'JWT': 'user-guide/web/echo/mid/jwt.md'
- 'CORS': 'user-guide/web/echo/mid/cors.md'
- 'Secure': 'user-guide/web/echo/mid/secure.md'
- 'CSRF': 'user-guide/web/echo/mid/csrf.md'
- 'gofiber/fiber':
- 'Swagger UI': 'user-guide/web/fiber/sw.md'
- 'Common API': 'user-guide/web/fiber/common.md'
- 'API Docs': 'user-guide/web/fiber/doc.md'
- 'PPROF': 'user-guide/web/fiber/pprof.md'
- 'Prometheus client': 'user-guide/web/fiber/prom.md'
- 'Config': 'user-guide/web/fiber/config.md'
- 'Embed': 'user-guide/web/fiber/embed.md'
- 'Environment variable': 'user-guide/web/fiber/env.md'
- 'Error type': 'user-guide/web/fiber/error-type.md'
- 'App info': 'user-guide/web/fiber/info.md'
- 'Log': 'user-guide/web/fiber/logging.md'
- 'Multiple entries': 'user-guide/web/fiber/multiple-entries.md'
- 'Override boot': 'user-guide/web/fiber/override.md'
- 'Graceful shutdown': 'user-guide/web/fiber/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/fiber/static-file-handler.md'
- 'TLS': 'user-guide/web/fiber/tls.md'
- 'Trace with logs': 'user-guide/web/fiber/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/fiber/mid/auth.md'
- 'Logging': 'user-guide/web/fiber/mid/logging.md'
- 'Prometheus': 'user-guide/web/fiber/mid/prom.md'
- 'Tracing': 'user-guide/web/fiber/mid/tracing.md'
- 'RequestId': 'user-guide/web/fiber/mid/meta.md'
- 'Ratelimit': 'user-guide/web/fiber/mid/ratelimit.md'
- 'JWT': 'user-guide/web/fiber/mid/jwt.md'
- 'CORS': 'user-guide/web/fiber/mid/cors.md'
- 'Secure': 'user-guide/web/fiber/mid/secure.md'
- 'CSRF': 'user-guide/web/fiber/mid/csrf.md'
- 'gogf/gf':
- 'Swagger UI': 'user-guide/web/gf/sw.md'
- 'Common API': 'user-guide/web/gf/common.md'
- 'API Docs': 'user-guide/web/gf/doc.md'
- 'PPROF': 'user-guide/web/gf/pprof.md'
- 'Prometheus client': 'user-guide/web/gf/prom.md'
- 'Config': 'user-guide/web/gf/config.md'
- 'Embed': 'user-guide/web/gf/embed.md'
- 'Environment variable': 'user-guide/web/gf/env.md'
- 'Error type': 'user-guide/web/gf/error-type.md'
- 'App info': 'user-guide/web/gf/info.md'
- 'Log': 'user-guide/web/gf/logging.md'
- 'Multiple entries': 'user-guide/web/gf/multiple-entries.md'
- 'Override boot': 'user-guide/web/gf/override.md'
- 'Graceful shutdown': 'user-guide/web/gf/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/gf/static-file-handler.md'
- 'TLS': 'user-guide/web/gf/tls.md'
- 'Trace with logs': 'user-guide/web/gf/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/gf/mid/auth.md'
- 'Logging': 'user-guide/web/gf/mid/logging.md'
- 'Prometheus': 'user-guide/web/gf/mid/prom.md'
- 'Tracing': 'user-guide/web/gf/mid/tracing.md'
- 'RequestId': 'user-guide/web/gf/mid/meta.md'
- 'Ratelimit': 'user-guide/web/gf/mid/ratelimit.md'
- 'JWT': 'user-guide/web/gf/mid/jwt.md'
- 'CORS': 'user-guide/web/gf/mid/cors.md'
- 'Secure': 'user-guide/web/gf/mid/secure.md'
- 'CSRF': 'user-guide/web/gf/mid/csrf.md'
- 'gorilla/mux':
- 'Swagger UI': 'user-guide/web/mux/sw.md'
- 'Common API': 'user-guide/web/mux/common.md'
- 'API Docs': 'user-guide/web/mux/doc.md'
- 'PPROF': 'user-guide/web/mux/pprof.md'
- 'Prometheus client': 'user-guide/web/mux/prom.md'
- 'Config': 'user-guide/web/mux/config.md'
- 'Embed': 'user-guide/web/mux/embed.md'
- 'Environment variable': 'user-guide/web/mux/env.md'
- 'Error type': 'user-guide/web/mux/error-type.md'
- 'App info': 'user-guide/web/mux/info.md'
- 'Log': 'user-guide/web/mux/logging.md'
- 'Multiple entries': 'user-guide/web/mux/multiple-entries.md'
- 'Override boot': 'user-guide/web/mux/override.md'
- 'Graceful shutdown': 'user-guide/web/mux/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/mux/static-file-handler.md'
- 'TLS': 'user-guide/web/mux/tls.md'
- 'Trace with logs': 'user-guide/web/mux/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/mux/mid/auth.md'
- 'Logging': 'user-guide/web/mux/mid/logging.md'
- 'Prometheus': 'user-guide/web/mux/mid/prom.md'
- 'Tracing': 'user-guide/web/mux/mid/tracing.md'
- 'RequestId': 'user-guide/web/mux/mid/meta.md'
- 'Ratelimit': 'user-guide/web/mux/mid/ratelimit.md'
- 'JWT': 'user-guide/web/mux/mid/jwt.md'
- 'CORS': 'user-guide/web/mux/mid/cors.md'
- 'Secure': 'user-guide/web/mux/mid/secure.md'
- 'CSRF': 'user-guide/web/mux/mid/csrf.md'
- 'zeromicro/go-zero':
- 'Swagger UI': 'user-guide/web/zero/sw.md'
- 'Common API': 'user-guide/web/zero/common.md'
- 'API Docs': 'user-guide/web/zero/doc.md'
- 'PPROF': 'user-guide/web/zero/pprof.md'
- 'Prometheus client': 'user-guide/web/zero/prom.md'
- 'Config': 'user-guide/web/zero/config.md'
- 'Embed': 'user-guide/web/zero/embed.md'
- 'Environment variable': 'user-guide/web/zero/env.md'
- 'Error type': 'user-guide/web/zero/error-type.md'
- 'App info': 'user-guide/web/zero/info.md'
- 'Log': 'user-guide/web/zero/logging.md'
- 'Multiple entries': 'user-guide/web/zero/multiple-entries.md'
- 'Override boot': 'user-guide/web/zero/override.md'
- 'Graceful shutdown': 'user-guide/web/zero/shutdown-hook.md'
- 'Static file handler': 'user-guide/web/zero/static-file-handler.md'
- 'TLS': 'user-guide/web/zero/tls.md'
- 'Trace with logs': 'user-guide/web/zero/trace-with-logs.md'
- 'Middleware':
- 'Auth': 'user-guide/web/zero/mid/auth.md'
- 'Logging': 'user-guide/web/zero/mid/logging.md'
- 'Prometheus': 'user-guide/web/zero/mid/prom.md'
- 'Tracing': 'user-guide/web/zero/mid/tracing.md'
- 'RequestId': 'user-guide/web/zero/mid/meta.md'
- 'Ratelimit': 'user-guide/web/zero/mid/ratelimit.md'
- 'JWT': 'user-guide/web/zero/mid/jwt.md'
- 'CORS': 'user-guide/web/zero/mid/cors.md'
- 'Secure': 'user-guide/web/zero/mid/secure.md'
- 'CSRF': 'user-guide/web/zero/mid/csrf.md'
- 'Database':
- 'mysql':
- 'Environment variable': 'user-guide/database/mysql/env.md'
- 'Logging': 'user-guide/database/mysql/logging.md'
- 'Plugin':
- 'Prometheus': 'user-guide/database/mysql/plugin/prom.md'
- 'postgreSQL':
- 'Environment variable': 'user-guide/database/postgres/env.md'
- 'Logging': 'user-guide/database/postgres/logging.md'
- 'Plugin':
- 'Prometheus': 'user-guide/database/postgres/plugin/prom.md'
- 'Developer guide': 'developer-guide/index.md'
- 'Plugins': 'plugin.md'
- 'Contribution':
- 'Guide': 'contribution/guide.md'
- 'Code of conduct': 'contribution/code-of-conduct.md'
extra_css:
- stylesheets/extra.css
copyright: Copyright © 2022 rookie ninja