框架及官网日常开发流程说明

@LiuYueKai 2016-07-07 14:13:39发表于 iuap-design/blog

前端框架源码修改说明

资源库介绍

前端框架修改过程中涉及框架源码库以及资源产出库

框架源码库(release分支维护)

目前框架源码库包括:iuap-desigin、grid、tree、kero、datetimepicker,均在release分支进行维护。

资源产出库(master分支维护)

generate-uui库进行源码资源的整体产出以及CDN资源托管。

在资源产出库通过以下命令可快速下载各个源码库

$ sh fetch.sh

执行命令会将iuap-desigin、grid、tree、kero、datetimepicker资源库下载到当前目录,并且切换到release分支。
建议各个源码库在此库目录下进行维护。

源码修改及提交流程

  • 对各个资源库进行资源修改之后在对应库执行gulp dist。
  • 将原始文件以及dist目录产出资源同时提交。
  • 在generate-uui根目录下执行gulp dist来产出最终资源。(此资源不用提交,看需要是否产出)

官网修改说明:iuap-design.github.io( master分支维护)

官网"开始使用"页签修改

  • 在iuap-design.github.io\docs\getting-started目录下修改对应的md文件

  • 目录下通过以下命令产出html文件

    $ gitbook serve

或者

$ gitbook build

官网"设计语言"页签修改

  • 在iuap-design.github.io\docs\design-language目录下修改对应的md文件

  • 目录下通过以下命令产出html文件

    $ gitbook serve

或者

$ gitbook build

官网"全局css样式"、"组件"页签修改

  • 在iuap-design工程修改snippets目录下资源

  • 执行app.js产出iuap-design下的docs以及examples内容

  • 将iuap-design下docs中的md文件拷贝至以下目录:

    iuap-design.github.io\docs\components

    iuap-design.github.io\docs\global-style

    注:目前需要手工拷贝,并且是从一个目录拷贝到另外一个目录,后续会将iuap-design下的docs生成2个目录并通过命令自动移动至对应目录

  • 在上面的2个目录下通过以下命令产出html文件

    $ gitbook serve

或者

$ gitbook build

官网"JS插件"页签修改

目前还未开发,后续开发过程与“全局css样式”、“组件”流程类似

官网"kero"页签修改

  • 在iuap-design.github.io\docs\kero目录下修改对应的md文件

  • 目录下通过以下命令产出html文件

    $ gitbook serve

或者

$ gitbook build

后续考虑修改流程与“全局css样式”、“组件”同步

官网"模板库"页签修改

  • 前端页面源码:iuap-design.github.io\dist\pages\template
  • 模板源码:

添加模板路径:iuap-design.github.io\dist\pages\website
配置模板页:iuap-design.github.io\src\data\template\index.json
配置需提供的参数
{
"title": "金融理财模板", //模板类型
"id": "0004", //模板id
"decription": "", //模板描述
"content_img": "img/main_6.png", //模板整页截图
"url": "http://design.yyuap.com/ficloud/home/statistics", //模板地址
"download": "javascript:;", //模板下载地址
"using_times": "228", //模板使用次数
"for_area": ["互联网","金融"] //模板适用领域
}

官网"webIDE"页签修改

  • 前端页面源码:iuap-design.github.io\dist\pages\webIDE

后续demos内容的源文件与“全局css样式”、“组件”中demo部分进行整合,webIDE更多提供开发工具方面的内容。

  • 运行对应服务:iuap-design.github.io\server\router.js

官网"定制"页签修改

  • 前端页面源码:iuap-design.github.io\dist\pages\custom
  • 下载服务:uap-design.github.io\server\customized.js

==注意点==:

官网中gitbook插件使用

官网页面除"模板库"、"webIDE"、"定制"页签,其他页签都是通过gitbook插件生成。由于插件在不断更新,如发现插件生成存在问题可通过以下方式更新插件。

  • 删除md文件存放目录下的node_modules下删除gitbook-plugin-iuap-design插件并重新执行

    $ gitbook install

下载最新插件。

  • 直接下载gitbook插件库至md文件存放目录下的node_modules中。插件库地址:

https://github.com/iuap-design/gitbook-plugin-iuap-design

官网中前端模板使用

官网页面"模板库"、"定制"页签使用前端模板进行开发。(卫东补充)

目前只是对当前开发流程进行梳理,发生变动以及未写明部分后续逐步完善。