diff --git a/docs/widget.md b/docs/widget.md index 86707d37..fbda3a1e 100644 --- a/docs/widget.md +++ b/docs/widget.md @@ -1 +1,62 @@ # 如何在Widget新增界面 + +阅读文档前, 请先阅读 go-cli 文档 + +在Widget列表页, 我们设有一个组, 名叫 **Developer**, 这个分组的作用是用来展示第三方作者提交的内容. 正常情况下会显示以下内容 + + + + +## 新建 Page + +在项目的根目录下使用 **goCLi createPage** 固定命令, 按照命令行提示信息. 输入新建界面的相关信息 + +``` +goCli createPage +``` +参考: +![](https://img.alicdn.com/tfs/TB1ms2Wc1H2gK0jSZFEXXcqMpXa-1393-228.gif) +按照以上操作会得到以下信息输出: +``` +{ + 界面位于 : lib/standard_pages/standard_for_slider_sanfan_8ab2b5c2_42ae_4241_9c8a_5c9e1f92b096 + Id : 8ab2b5c2_42ae_4241_9c8a_5c9e1f92b096 + 文件夹名称 : standard_for_slider_sanfan_8ab2b5c2_42ae_4241_9c8a_5c9e1f92b096 +} + +``` + +### 字段注意事项 + +**name** 必须**英文开头**, 统一用小写的英文字母,数字和下划线的组合,不得包含汉字空格和特殊字符, 需要与文章内容相关 + + +**author** 可以为中文英文以及任意组合, 但是不得有歧义, 暴力, 辱骂等词汇, 否则可能会被拒绝合并 + +**desc** 相关的简要描述, 需要对添加的组件或者界面进行简要描述, 方便后期搜索引擎采集 + +**email** 创建者的邮箱 + +## 查看创建的 Page + +为了能正确的加载出新的界面, 建议重新启动当前项目. 在**Widget -> Developer -> 本地代码**中,您可以找到您新建的界面 + + + + +## 编辑界面 + +为了能动态的将**markdown**转化成**可识别**的内容, 需要在您项目中调用 **goCli watch**, 然后可以编辑以下位置的md文件, 更改当前文件内容, 即可动态更新我们详情页的内容. + +``` +lib/standard_pages/standard_for_slider_sanfan_8ab2b5c2_42ae_4241_9c8a_5c9e1f92b096/index.md +``` + +参考: + +![](https://img.alicdn.com/tfs/TB1cHLZc.T1gK0jSZFhXXaAtVXa-1393-760.gif) + + +## 引用Flutter 实例 + +如何在markdown中引用flutter widget实例请参考: [WidgetDemo](https://github.com/alibaba/flutter-go/blob/beta/go-cli/utils/tpl.md) diff --git a/go-cli/utils/tpl.md b/go-cli/utils/tpl.md index 69a71380..0123b232 100644 --- a/go-cli/utils/tpl.md +++ b/go-cli/utils/tpl.md @@ -2,7 +2,7 @@ 您可以在这个界面中, 编写大多数的markdown文案, 他会在 **goCli watch** 下同步被编译成 **dart** 文件 -您可以通过goCli创建详情页所需要的demo +您可以通过goCli固定命令创建详情页所需要的 **Flutter 实例** ``` goCLi createDemo @@ -44,9 +44,17 @@ goCLi createDemo 您可以在任意详情页中, 通过以下方式调用 ``` -[demo:1a29aa8e_32ae_4241_9c8a_5c9e1f92b096] +[demo: 1a29aa8e_32ae_4241_9c8a_5c9e1f92b096] ``` -调用效果: +# 注意事项 + +**name** 必须**英文开头**, 统一用小写的英文字母,数字和下划线的组合,不得包含汉字空格和特殊字符, 需要与文章内容相关 + + +**author** 可以为中文英文以及任意组合, 但是不得有歧义, 暴力, 辱骂等词汇, 否则可能会被拒绝合并 + +**desc** 相关的简要描述, 需要对添加的组件或者界面进行简要描述, 方便后期搜索引擎采集 + +**email** 创建者的邮箱 -[demo:1a29aa8e_32ae_4241_9c8a_5c9e1f92b096] \ No newline at end of file