diff --git a/docs/src/.vuepress/public/favicon.ico b/docs/src/.vuepress/public/favicon.ico index b411f79d..01f90477 100644 Binary files a/docs/src/.vuepress/public/favicon.ico and b/docs/src/.vuepress/public/favicon.ico differ diff --git a/docs/src/.vuepress/theme.ts b/docs/src/.vuepress/theme.ts index 268304b1..ca477829 100644 --- a/docs/src/.vuepress/theme.ts +++ b/docs/src/.vuepress/theme.ts @@ -12,7 +12,9 @@ export default hopeTheme({ iconAssets: "fontawesome-with-brands", - logo: "https://oss.jaronnie.com/avatar.png", + // made by https://gopherize.me + // favicon.ico made by https://www.bitbug.net + logo: "https://oss.jaronnie.com/jzero.jpg", repo: "jaronnie/jzero", diff --git a/docs/src/guide/config/README.md b/docs/src/guide/config/README.md new file mode 100644 index 00000000..2c6a3665 --- /dev/null +++ b/docs/src/guide/config/README.md @@ -0,0 +1,9 @@ +--- +title: 配置模块 +icon: gears +index: false +dir: + order: 5 +--- + + \ No newline at end of file diff --git a/docs/src/guide/config/logger.md b/docs/src/guide/config/logger.md new file mode 100644 index 00000000..e637f375 --- /dev/null +++ b/docs/src/guide/config/logger.md @@ -0,0 +1,9 @@ +--- +title: 日志配置 +icon: gears +star: true +order: 1 +category: 配置 +tag: + - Guide +--- \ No newline at end of file diff --git a/docs/src/guide/config/prometheus.md b/docs/src/guide/config/prometheus.md new file mode 100644 index 00000000..73497e29 --- /dev/null +++ b/docs/src/guide/config/prometheus.md @@ -0,0 +1,9 @@ +--- +title: prometheus 配置 +icon: gears +star: true +order: 2 +category: 配置 +tag: + - Guide +--- \ No newline at end of file diff --git a/docs/src/guide/config/telemetry.md b/docs/src/guide/config/telemetry.md new file mode 100644 index 00000000..b4f53735 --- /dev/null +++ b/docs/src/guide/config/telemetry.md @@ -0,0 +1,9 @@ +--- +title: 链路追踪配置 +icon: gears +star: true +order: 3 +category: 配置 +tag: + - Guide +--- \ No newline at end of file diff --git a/docs/src/guide/develop/README.md b/docs/src/guide/develop/README.md new file mode 100644 index 00000000..2d386264 --- /dev/null +++ b/docs/src/guide/develop/README.md @@ -0,0 +1,9 @@ +--- +title: 开发模块 +icon: puzzle-piece +index: false +dir: + order: 6 +--- + + \ No newline at end of file diff --git a/docs/src/guide/develop/proto.md b/docs/src/guide/develop/proto.md new file mode 100644 index 00000000..e6869866 --- /dev/null +++ b/docs/src/guide/develop/proto.md @@ -0,0 +1,9 @@ +--- +title: proto 规范 +icon: puzzle-piece +star: true +order: 1 +category: 开发 +tag: + - Guide +--- \ No newline at end of file diff --git a/docs/src/guide/develop/template.md b/docs/src/guide/develop/template.md new file mode 100644 index 00000000..2235a274 --- /dev/null +++ b/docs/src/guide/develop/template.md @@ -0,0 +1,9 @@ +--- +title: 模版定制化 +icon: puzzle-piece +star: true +order: 2 +category: 开发 +tag: + - Guide +--- \ No newline at end of file diff --git a/docs/src/guide/gen.md b/docs/src/guide/gen.md index 6fc1c494..87322c2e 100644 --- a/docs/src/guide/gen.md +++ b/docs/src/guide/gen.md @@ -36,78 +36,4 @@ curl http://localhost:8001/api/v1.0/credential/version grpcurl -plaintext localhost:8000 credentialpb.credential/CredentialVersion # api curl http://localhost:8001/api/v1/hello/me -``` - -执行命令后的代码结构为: - -```shell -$ tree -. -├── cmd -│   ├── daemon.go -│   └── root.go -├── config.toml -├── daemon -│   ├── api -│   │   ├── app1.api -│   │   ├── file.api -│   │   └── hello.api -│   ├── daemon.go -│   ├── internal -│   │   ├── config -│   │   │   └── config.go -│   │   ├── handler -│   │   │   ├── file -│   │   │   │   ├── downloadhandler.go -│   │   │   │   └── uploadhandler.go -│   │   │   ├── hello -│   │   │   │   ├── helloparamhandler.go -│   │   │   │   ├── hellopathhandler.go -│   │   │   │   └── helloposthandler.go -│   │   │   ├── myhandler.go -│   │   │   ├── myroutes.go -│   │   │   └── routes.go -│   │   ├── logic -│   │   │   ├── credential -│   │   │   │   └── credentialversionlogic.go -│   │   │   ├── credentialv2 -│   │   │   │   └── credentialversionlogic.go -│   │   │   ├── file -│   │   │   │   ├── downloadlogic.go -│   │   │   │   └── uploadlogic.go -│   │   │   ├── hello -│   │   │   │   ├── helloparamlogic.go -│   │   │   │   ├── hellopathlogic.go -│   │   │   │   └── hellopostlogic.go -│   │   │   ├── machine -│   │   │   │   └── machineversionlogic.go -│   │   │   └── machinev2 -│   │   │   └── machineversionlogic.go -│   │   ├── server -│   │   │   ├── credential -│   │   │   │   └── credentialserver.go -│   │   │   ├── credentialv2 -│   │   │   │   └── credentialv2server.go -│   │   │   ├── machine -│   │   │   │   └── machineserver.go -│   │   │   └── machinev2 -│   │   │   └── machinev2server.go -│   │   ├── svc -│   │   │   └── servicecontext.go -│   │   └── types -│   │   └── types.go -│   ├── pb -│   │   ├── credentialpb -│   │   │   ├── credential.pb.go -│   │   │   └── credential_grpc.pb.go -│   │   └── machinepb -│   │   ├── machine.pb.go -│   │   └── machine_grpc.pb.go -│   └── proto -│   ├── credential.proto -│   └── machine.proto -├── go.mod -└── main.go - -27 directories, 39 files ``` \ No newline at end of file diff --git a/docs/src/guide/new.md b/docs/src/guide/new.md index 2a14142b..2a8a3c98 100644 --- a/docs/src/guide/new.md +++ b/docs/src/guide/new.md @@ -12,34 +12,4 @@ flag 解释: * module 表示新建项目的 go module * dir 表示创建的项目目录路径 -* app 表示项目名 - -生成的代码结构: - -```shell -$ tree -. -├── cmd -│   ├── daemon.go -│   └── root.go -├── config.toml -├── daemon -│   ├── api -│   │   ├── app1.api -│   │   ├── file.api -│   │   └── hello.api -│   ├── daemon.go -│   ├── internal -│   │   ├── config -│   │   │   └── config.go -│   │   └── handler -│   │   ├── myhandler.go -│   │   └── myroutes.go -│   └── proto -│   ├── credential.proto -│   └── machine.proto -├── go.mod -└── main.go - -8 directories, 14 files -``` \ No newline at end of file +* app 表示项目名 \ No newline at end of file