flutter/flutter-go
1
0
Fork 0
mirror of https://github.com/alibaba/flutter-go.git synced 2025-05-17 12:55:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

update: doc

Browse Source
This commit is contained in:
sanfan.hx
2019-08-12 14:32:11 +08:00
parent d79364b2b4
commit 04144c6719
5 changed files with 85 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
.github/ISSUE_TEMPLATE/widget about.md → .github/ISSUE_TEMPLATE/page-about.md vendored
View File

@ -1,9 +1,9 @@
---
name: "📄 Widget About"
about: something about widget
name: "📄 Page About"
about: something about page
---
## Widget About
## Page About
**仅限中文与英文**, 其他语言的提交将直接被关闭
@ -13,8 +13,29 @@ about: something about widget
如果长时间未得到您的回复, 如果我们无法在某些环境上重现该问题, 并且您**超过7天未回复**, 我们可能会关 **闭掉issue**, 谢谢
## 描述widget 类型
## Page 标题
(例如: *"xx介绍页"*)
## Page 增加或者更新的内容概括
## Page 关联的 DEMO 信息
例如:
```
{
"name": "intor page",
"screenShot": "",
"author":"sanfan",
"title":"介绍页",
"email": "hanxu317@qq.com",
"desc": "desc",
"id": "ee4feb8e_32ae_4241_9c8a_5c9e1f92b096"
}
```
## 引入第三方包的文件与版本号
## widget 简要描述
##

40
docs/contribute.md
View File

@ -1,25 +1,35 @@
# Flutter Go PR 规范说明
# Flutter Go 共建
# 贡献指南
# 共建说明
此项目遵循[贡献者行为准则](https://github.com/spring-projects/spring-framework/blob/master/CODE_OF_CONDUCT.adoc)。参与此项目即表示您同意遵守其条款.
由于 **Flutter 版本迭代速度较快**,产生的内容较多, 而我们**人力有限**无法更加全面快速的支持Flutter Go的日常维护迭代, 如果您对flutter go的共建感兴趣, 欢迎您来参与本项目的共建.
**凡是参与共建的成员. 我们会将您的头像与github个人地址收纳进我们的官方网站中.**
# 共建方式
1. 本次更新, 开放了 **Widget 内容收录** 的功能, 您可以通过 [goCli](https://github.com/alibaba/flutter-go/blob/master/docs/go-cli.md) 工具编写markdown代码, 通过 **Pull Request** 的形式将您的文章内容, api描述, 组件使用方法等加入进我们的Widget界面.
2. 您也可以将例如**日常bug.** **未来feature**等的功能性PR, 申请提交到我们的的主仓库.
如何提PR请先阅读以下文档
- [如何提PR](https://github.com/alibaba/flutter-go/blob/master/docs/push-pr.md)
- [如何使用go-cli](https://github.com/alibaba/flutter-go/blob/master/docs/go-cli.md);
- [dart 代码规范](https://github.com/alibaba/flutter-go/blob/beta/Flutter_Go%20%E4%BB%A3%E7%A0%81%E5%BC%80%E5%8F%91%E8%A7%84%E8%8C%83.md)
# Issue
pr的第一步是先提交issue，即提交你发现的BUG 或者 想加入的功能, 选择你issue在类型
# 参与共建
我们采用 **Pull Request(简称PR)** 的方式, 进行三方共建.
关于如何提PR请先阅读以下文档
- [如何向仓库提交 Pull Request](https://github.com/alibaba/flutter-go/blob/master/docs/push-pr.md)
- [dart 代码规范](https://github.com/alibaba/flutter-go/blob/master/Flutter_Go%20%E4%BB%A3%E7%A0%81%E5%BC%80%E5%8F%91%E8%A7%84%E8%8C%83.md)
- [如何使用go-cli 创建 Widget Page](https://github.com/alibaba/flutter-go/blob/master/docs/go-cli.md)
为了更好记录您的改动目的, 内容信息, 交流过程, 每一条PR都需要对应一条 **Issue**, 即提交你发现的BUG 或者 想加入的功能, 或者想要加入的 Widget Page, 选择你issue在类型
![](https://img.alicdn.com/tfs/TB1r3LEbKL2gK0jSZFmXXc7iXXa-858-317.png)
# 贡献指南
您的 Issue 可能包含以下几种
- bug report (修复逻辑相关bug)
- feature (增加新的功能)
- widget (关于widget示例展示)
此项目遵循[贡献者行为准则](https://github.com/spring-projects/spring-framework/blob/master/CODE_OF_CONDUCT.adoc)。参与此项目即表示您同意遵守其条款.

87
docs/go-cli.md
View File

@ -1,8 +1,8 @@
# GoCli 使用方式
# GoCli 说明
## 安装
获取最新flutterGo代码分之后. 在源文件下会有 **go-cli** 的文件.
获取最新flutterGo代码分之后. 在项目下会有 **go-cli** 的文件夹.
首先进入该文件夹并安装go-cli所需要的依赖
@ -14,7 +14,7 @@ pub get
然后使用pub global命令将文件包注册到全局
```
pub global activate --source path /{your flutter go absolute path}/fluttergo/go-cli
pub global activate --source path /{your project absolute path}/flutter-go/go-cli
```
@ -27,67 +27,53 @@ goCli 1.0.0 at path "/{youpath}/flutter-go/go-cli"
## 使用方式
现在支持以下几种命令
- createDemo 新增flutter go demo.
- createPage 新增flutter go page.
- watch 动态生成文档与demo相关
### createDemo
动态生成widget demo, 可以创建demo.以便详情页中使用
在flutter go 根文件下通过命令行输入以上命令可以进行以下操作
[✓] 请输入新增加的demo名称? demoName
## 固定命令
[✓] 请输入您的姓名(使用英文) yourName
### goCli createPage
[✓] 请输入您的github的email地址 yourEmail
初始化并创建一个Widget详情页, 通常来说. 当我们需要在Widget Tab下. 新加入一个界面内容, 执行该条命令, 会根据您的输入, 自动在本项目中创建对应的文件夹, 并记录相关配置信息, 在创建的目录中, 您可以通过编写markdown代码, 进行文章内容的编写.
[✓] 请输入您demo的描述 这是一个测试的标准demo
### goCli createDemo
初始化并创建一个可实例化的Widget Demo(实例块), 按照在命令行中的提示, 输入我们的相关信息, 我们会创建一个 关于demo 的文件夹. 并会得到一个唯一的 **ID**. 我们可以通过这条ID,在我们的markdown代码中, 进行直接调用.
在完成以上操作后, 可以得到这样的输出:
```
------------------
您新增的组件信息如下
==================
{
name : demoName
author : yourName
email : yourEmail
desc : 这是一个测试的标准demo
}
==================
[✓] Is this the config you want ? (Y/n) y
{
新建的demo文件位于 : /flutter go/lib/page_demo_package/demoName_yourName_1a29aa8e_32ae_4241_9c8a_5c9e1f92b096
demoId为 : 1a29aa8e_32ae_4241_9c8a_5c9e1f92b096
markdown中调用方式 : [demo:1a29aa8e_32ae_4241_9c8a_5c9e1f92b096]
}
```
您可以在任意详情页中, 通过以下方式调用
例如:
```
[demo: 1a29aa8e_32ae_4241_9c8a_5c9e1f92b096]
```
### goCli build
将本地的界面与实例资源进行打包开成统一的独立的入口. 在拉取flutter-go的项目代码后. 需要执行当前命令. 否则会报错.
### createPage
### goCli watch
使用方式同上. 通过该命令可以创建标准的详情页.您可以通过修改index.md进行动态的更新您所创建的详情页.
动态便宜Widget Page, 动态进行markdown => dart 代码的转换. 通常在我们编辑Widget page的index.md的时候进行文件监听. 动态生成, 进行本地热更新.
目录结构为
## 注意
- 在修改**page\_demo\_package**或者standard\_pages目录下的文件操作时. 请先执行 **goCLi watch**
- **name**, **author** 字段必须使用英文开头, 不允许使用特殊符号. 正常的示范 name ='name_test' author = 'abcdefg';
- 以下文件目录, 显示**不可人为修改的文件**, 凡是被**合进master主分支的代码**不允许进行任何修改.
```
// demo 文件结构
demoName_yourName_1a29aa8e_32ae_4241_9c8a_5c9e1f92b096/
├── .demo.json (不可人为修改)
├── index.dart (不可人为修改)
└── src
└── index.dart (可修改)
// widget page 文件结构
standard_pages/
├── index.dart (不可人为修改)
└── standard_sanfan_ee4feb8e_32ae_4241_9c8a_5c9e1f92b096
@ -96,14 +82,3 @@ standard_pages/
└── index.md (可修改)
```
### watch
监听并编译standard_pages与page_demo_package下的的文件改动. 动态处理demo目录与文件markdown转化等.
## 注意
- 在修改page_demo_package或者standard_pages目录下的文件操作时. 建议在flutterGo目录执行goCLi watch 开启文件动态编译
- name, author 字段必须使用英文开头, 不允许使用特殊符号. 正常的示范 name ='name_test' author = 'abcdefg';
- 暂时阶段demo与page,一经过创建不允许修改名称作者等信息. 凡是被收录进主分支的不允许被删除

1
docs/widget.md Normal file
View File

@ -0,0 +1 @@
# 如何在Widget新增界面

1
go-cli/Readme.md
View File

@ -34,6 +34,7 @@ goCli 1.0.0 at path "/{youpath}/flutter-go/go-cli"
- createDemo 新增flutter go demo.
- createPage 新增flutter go page.
- watch 动态生成文档与demo相关
- build 生成文档与demo相关
### createDemo