doc: 优化docsify文档体验

1.调整在docsify下代码块乱掉的问题
2.新增docsify下的go/yaml/vue/json/sql代码高亮插件
3.新增docsify下的mermaid图解析插件
This commit is contained in:
zjy
2025-07-13 18:29:28 +08:00
parent 5efae235e4
commit 35c6387b4b
11 changed files with 905 additions and 869 deletions

View File

@@ -63,16 +63,17 @@
#### import
* 单行import不建议用圆括号包裹
* 按照`官方包`NEW LINE`当前工程包`NEW LINE`第三方依赖包`顺序引入
```go
import (
"context"
"string"
"greet/user/internal/config"
"google.golang.org/grpc"
)
```
```go
import (
"context"
"string"
"greet/user/internal/config"
"google.golang.org/grpc"
)
```
#### 函数返回
* 对象避免非指针返回
@@ -84,7 +85,8 @@
#### 函数体编码
* 建议一个block结束空一行如if、for等
```go
```go
func main (){
if x==1{
// do something
@@ -92,15 +94,16 @@
fmt.println("xxx")
}
```
```
* return前尽可能空一行
```go
func getUser(id string)(string,error){
....
return "xx",nil
}
```
```go
func getUser(id string)(string,error){
....
return "xx",nil
}
```
### 框架规范