feat(jzero): update docs

jzero-io · Jun 20, 2024 · a996b9e · a996b9e
1 parent fd561f2
commit a996b9e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/docs/src/guide/develop/model.md b/docs/src/guide/develop/model.md
@@ -17,7 +17,14 @@ jzero 数据库规范:
 
 jzero gen 时会自动检测 desc/sql 下的 sql 文件, 并将生成的 model 放在 internal/model 下
 
-另外推荐使用 sqlbuilder 完成对 sql 的拼接. 如获取凭证列表以及支持过滤参数
+另外推荐使用 sql-builder 完成对 sql 的拼接. 如获取凭证列表以及支持过滤参数
+
+## 将默认生成的 crud 代码替换为使用 sql-builder 的方式
+
+```shell
+git clone https://github.com/jzero-io/sqlbuilder-zero
+cp -r sqlbuilder-zero/templates/go-zero/model ~/.jzero/$Version/go-zero
+```
 
 ```shell
 go get github.com/huandu/go-sqlbuilder

diff --git a/docs/src/guide/develop/template.md → docs/src/guide/template.md b/docs/src/guide/develop/template.md → docs/src/guide/template.md
@@ -1,8 +1,8 @@
 ---
-title: 模版定制化
+title: 模版
 icon: puzzle-piece
 star: true
-order: 2
+order: 5.2
 category: 开发
 tag:
   - Guide
@@ -11,10 +11,18 @@ tag:
 jzero gen 生成代码, 仍然是依赖于 goctl 工具.
 
 ```shell
-# 初始化的模板位置: ~/.jzero/Version 下, 可以修改模板后再进行新建项目
+# 初始化的模板位置: ~/.jzero/$Version 下, 可以修改模板后再进行新建项目
 jzero template init
 # 或者 jzero template init --home .template
 
 # 如果仍需要扩展 go-zero 的 template
 goctl template init --home .template/go-zero
+```
+
+## 将当前项目转化为 jzero 的模板
+
+```shell
+jzero template build --name my_template
+
+jzero new my_template_project --branch my_template
 ```