该项目是运用 Jekyll 生成静态网站之后,部署(上传)到 公司 GitHub 的项目主页上。
- 建立两个目录
- 一个关联到内网 GitLab 的
youyu-ui-library
用于开发(以下称为「开发目录」) - 另一个关联到
https://github.com/cimutech/youyu-fe.git
并切换到gh-pages
分支用来部署(以下称为「部署目录」)
在开发目录中编写源码(具体方法参照 Jekyll 官网),然后终端输入 bundle exec jekyll serve
来运行查看结果。
- 在部署目录中
pull
一下最新的代码 - 终端中的当前位置设置为在开发目录中
- 输入
bundle exec jekyll build -d 部署目录的相对路径
生成静态网页到部署目录中 commit
并push
到 GitHub 上
上述操作都做完,即可访问 http://fe.youyu.im/ 查看效果。
生成有渔 UI 库的样例页面
rake ui_examples
该任务会根据 _data/navs.json
中所定义的数据生成样例页面文件到 _docs/ui/examples/
文件夹里。
生成 YouYu 对象的 API 页面
rake youyu_apis
该任务会根据 _data/navs.json
中所定义的数据生成 API 页面文件到 _docs/youyu/apis/
文件夹里。
rake run
该任务会调用 rake ui_examples
和 rake youyu_apis
。
rake deploy
该任务会调用 rake ui_examples
和 rake youyu_apis
。