您的位置:首页 > 移动开发 > Swift

gem淘宝镜像,ios swift jazzy文档生成 教程

2016-02-15 11:19 621 查看
ios文档生成中的时候,OC 很简单,文档也很多,那么我们今天就来说说Swfit版本的文档生成工具吧。

我们用到的工具是:jazzy

那么让我们来安装吧!

首先打开JAZZY项目地址:https://github.com/realm/jazzy   [sudo]
gem install jazzy

但是当我们在控制台执行这一句话的时候会提示无法找到资源,相信大家都是用的淘宝的镜像地址:

mrshan-2:~ mrshan$ gem sources -l
*** CURRENT SOURCES *** http://ruby.taobao.org/ https://ruby.taobao.org/
如果没有红色标示出来的镜像地址那么添加上即可。
安装好JAZZY之后就是使用了,新建一个项目用来测试,然后控制台进入到项目目录(和cocoapods类似)执行下面列出来的命令即可。

jazzy 
--author Mrshan 
第一个是作者,

--module-version 1.0 
第二个是要文档的项目的版本号

--module jazzyswift
,第三个是项目名称

--github_url https://github.com/hatjs880328/jazzymrshan index页面中github的链接地址

--author_url http://www.sina.com 作者网站,点击作者姓名时候跳转的网站

例子:jazzy --clean --author Mrshan --module-version 1.0 --module jazzyswift --github_url https://github.com/hatjs880328/jazzymrshan --author_url http://www.sina.com
转载请注明作者,谢谢合作。

内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息