SHJavascriptInterface 1.02

SHJavascriptInterface 1.02

测试已测试
语言语言 Obj-CObjective C
许可证 MIT
发布最后发布2016年7月

7heaven维护。



  • 作者
  • 7heaven

CocoaDocs.org

CocoaDocs实际上包含两个工具,一个是用于生成复杂appledoc模板的脚本,另一个是用于响应webhook通知的服务器方面。

针对99%用例的工作原理

CocoaDocs在从GitHub上的CocoaPods/Specs库更新CocoaPod时接收webhook通知。

这会触发一个通过appledoc生成 dokumentations für objective-c 项目的进程,并将它们托管到社区。在将Podspec通过trunk发布后,这个过程可能需要大约15分钟。

目前,由于努力迁移到队列系统,我们这边可能会出现404错误。假设您的库由objc组成。

作为库作者,我对CocoaDocs拥有什么控制权?
  • 您有能力编辑CocoaDocs您自己的库的样式,以赋予一些个人品牌。这是通过在库的根目录中添加一个.cocoadocs.yml文件来完成的,该文件将覆盖这些属性

    highlight-font: '"GT Walsheim", "gt_walsheim_regular", "Avant Garde Gothic ITCW01Dm", "Avant Garde", "Helvetica Neue", "Arial"'
    
    body: '"Helvetica Neue", "Arial", san-serif'
    code: '"Monaco", "Menlo", "Consolas", "Courier New", monospace'
    
    highlight-color: '#ED0015'
    highlight-dark-color: '#A90010'
    
    darker-color: '#C6B7B2'
    darker-dark-color: '#A8A8A8'
    
    background-color: '#F2F2F2'
    alt-link-color: '#B7233F'
    warning-color: '#B80E3D'

    所有默认值都存储在这个配置文件中,以便您可以覆盖它们。

  • 您可以在ARAnalytics的.cocoadocs.yml找到样式的示例

  • 您可以添加自己的文档指南,无论是来自远程markdown文件还是库中本地文件。CocoaDocs将自动将GitHub wiki页面转换为它后面的markdown。

    additional_guides:
     - https://github.com/magicalpanda/MagicalRecord/wiki/Installation
     - https://github.com/CocoaPods/CocoaPods/wiki/A-pod-specification
     - docs/Getting_started.md
  • 如果您托管自己的文档,并且/或者更喜欢不使用CocoaDocs,您可以在Podspec中使用documentation_url引用。

在CocoaDocs中预览我的库

首先,克隆此仓库:git clone https://github.com/CocoaPods/cocoadocs.org,然后运行bundle install,然后运行bundle exec rake install_tools以设置所有先决应用程序。

要预览您的库,请运行:

bundle exec ./cocoadocs.rb preview ARAnalytics

这将获取您的库的master版本,然后通过CocoaDocs运行它,然后打开生成的文件夹,您可以在Web浏览器中打开index.html来本地预览。

CocoaDocs管理员

CocoaPods 的 CocoaDocs 服务器托管在由 Button(http://www.usebutton.com/)提供的 macminicolo.net 上。我们使用 RSA 公钥进行登录。您需要将您的 id_rsa.pub 提交给现有的管理员(目前为 ortasegiddins)以获得访问权限。

SSH 访问通过 Rakefile 自动化。

  • bundle exec rake deploy - 将通过 SSH 登录,停止 API 服务器,更新它,然后将服务器重新启动。

  • bundle exec rake doc["pod_name"] - 将通过 SSH 登录,并运行 pod 的重新生成文档。类似于重新部署 API,但您可以看到日志。

感谢!

CocoaDocs v2 的创建得到了以下人士的支持