在 WordPress 中使用 Github README 标签

原文链接=http://dev.iachieved.it/iachievedit/github-readme-badges-in-wordpress/
作者=Joe
原文日期=2016/01/24


Github 上的很多框架和包都在他们的 README 文件中使用 “badges”(标签)记录 repository 的不同属性。

  • 一个 repository 的 Travis 构建(译者注:Travis CI 是开源持续集成构建项目)是否通过
  • 一个 release 版本代码的下载次数
  • 代码支持的平台(为苹果设备开发时尤其有用)

这里写图片描述

自2014年6月初次发布以来,Swift 编程语言已经经历过了一系列的改变和版本。每一个发行版本都包含了破坏性的改变。从这篇文章开始,我已经开始使用标签去指明文章所兼容的 Swift 版本。

添加标签

你可以在你的 WordPress 文章中通过两种技术使用标签。严格地获取标签的最好方式是使用内联图片设计使之看起来像,好吧,就是像标签。你也可以自己创建图片或者使用类似 Shields.io 的服务去链接标签。不管什么方式,为了在你的页面展示标签你都应该使用<img/>。一个通过 Shields.io 链接标签的描述例子如下:

1
<img src="https://img.shields.io/badge/Swift-2.2-orange.svg?style=flat" alt="Swift 2.2" />

这会出现这样的标签:Swift 2.2

此外你还可以使用 Markdown 语法(如你在 Github 的 README.md 文件所见的那样)。为了在 WordPress 中使用 Markdown,你可以加载 jetpack 组件,然后激活它的 Markdown 组件。通过 Markdown 的支持激活创建一篇新的文章,并且可以在文章编辑这样的类型:

Swift 2.2

这使用了 Markdown 的图片语法,并且可以出现这样的标签:Swift 2.2

Shields.io

Shields.io 的设计理念是: “标签是一个服务”。换句话说,无需担心创建你自己的标签,Shields.io 会为你创建标签。大多数的 Shields.io 标签在语义上和“一些东西”的状态捆绑在一起。例如,URL:https://img.shields.io/github/downloads/atom/atom/total.svg 提供了一个标签指明 Atom 程序被下载的所有次数。Shields.io 首先通过联系 Github 的接口获取到真实的下载数量,然后返回生成的图片。

上述 Swift 的例子使用了这个 Shields.io URL:
https://img.shields.io/badge/<SUBJECT>-<STATUS>-<COLOR>.svg。我们通过提供如下几个选项使用他:

  • SUBJECT 为 Swift
  • STATUS 为 2.2
  • COLOR 为 orange

当然,orange 是由于它是Swift的代表色。

准确的评价

我非常推荐每一个Swift 博主开始使用标签 (或者一些等同的形式)去指明 Swift 语言的版本,如例子所示的那样。例如,尽管 C 风格的循环已经在 Swift 2.2 中废弃了,但是会在 3.0 中产生错误。当某个人看到你的 2.2 版本的文章,但是试图使用 3.0 的编译器运行代码,他们至少应该知道有些代码可能不兼容。