README

Badges 徽章

Shields.io: Quality metadata badges for open source projects  徽章

官网:https://shields.io

GitHub项目README,其中不乏用到一些非常好看的标签。比如下面这样:

Your BADGE 生成

1.在shields.io 生成自己的标签,注意:生成栏在网站的最下面,下面的图片就是我生成  需要在Your Badge下面填的内容。之后它会生成唯一链接。https://img.shields.io/badge/download-1K-brightgreen.svg

2.因为README默认支持MarkDown语法。所以我们很容易插入图片和用图片做为链接跳转到别处。下面分别演示。继续以  为例。

a.只是显示图片

MarkDown语法显示图片: ![图片描述](图片链接)
![](https://img.shields.io/badge/download-1K-brightgreen.svg)

b.让图片做为链接

MarkDown语法创建链接: [链接名](网址)
[百度](https://www.baidu.com)

百度

在此基础上,我们把`链接名`换成`图片`不就好了:
[![图片描述](图片链接)]()
[![](https://img.shields.io/badge/download-1K-brightgreen.svg)](https://www.baidu.com)

(点击进入百度)


Downloads 下载量标签

以npm的下载量为例:

首先,我们要保证我们的库已经publish到npm上,然后,进入该网站配置你的npm仓库代码。

点击【666/month】的链接会看见如下界面:

Link,意思是点击该标签会跳转的地址,一般我们就直接跳转到npm的地址即可;
Image,就是动态显示成你标签的关键。观察示例链接不难发现前面都是该域名的地址,从npm开始则是我们标签配置的地方。
npm,指我们需要获取npm的数据,
dm,就是月下载量,后面的[localeval].svg就是需要改成你的npm仓库名位置了。 所以比如将这个链接改为https://img.shields.io/npm/dm/v-tap.svg 就是我v-tap在npm上的数据下载量了。如下图: 同理,比如你要获取npm版本;示例链接如下是https://img.shields.io/npm/v/npm.svg
改成:https://img.shields.io/npm/v/v-tap.svg 就是我v-tap的了:


Build 标签

那关于集成测试的如何显示呢?以react的为例,他们使用的是circleCI来集成构建。

首先,需要在你的项目下编写circleCI的配置文件

machine:

node:

version: 6

test:

override:

- npm test

这是一个非常简单的circle.yml配置文件,当我们提交代码的时候circle会自动帮我们构建并且执行npm test进行测试。如果测试都通过了则build passing

然后,只需要我们在:https://img.shields.io 找到 CircleCI的标签,跟下载量一样,修改下它的链接即可:

https://img.shields.io/circleci/project/github/[username]/[repo].svg

如我github的username是MeCKodo,一个配置了circle的repo为webpack-browser-log则标签的链接为https://img.shields.io/circleci/project/github/MeCKodo/webpack-browser-log.svg。显示如下

其他也都是大同小异!快去装饰你的repo吧!


GitHub Pages

绑定域名

DevOps - 版本控制 - GitHub的更多相关文章

  1. 版本控制-GitHub

    前面几篇文章,我们介绍了Git的基本用法及Git服务器的搭建,本篇文章来学习一下如何使用GitHub.GitHub是开源的代码库以及版本控制库,是目前使用网络上使用最为广泛的服务,GitHub可以托管 ...

  2. 版本控制--github相关

    安装 Git 后,你应该做一些只需做一次的事情:系统设置——这样的设置在每台电脑上只需做一次: $ git config --global user.name "Your Name" ...

  3. DevOps - 版本控制 - Git

    配置 .gitignore 配置 .gitignore 配置文件用于配置不需要加入版本管理的文件,配置好该文件可以为我们的版本管理带来很大的便利. 有些时候,你必须把某些文件放到Git工作目录中,但又 ...

  4. DevOps - 版本控制 - Gogs

    Gogs Gogs官网:https://gogs.io Gogs文档:https://gogs.io/docs Gogs配置文件手册:https://gogs.io/docs/advanced/con ...

  5. DevOps - 版本控制 - Bitbucket

    Bitbucket 使用139邮箱无法收到注册邮件 https://bitbucket.org

  6. 基于Github Actions + Docker + Git 的devops方案实践教程

    目录 为什么需要Devops 如何实践Devops 版本控制工具(Git) 学习使用 配置环境 源代码仓库 一台配置好环境的云服务器 SSH远程登录 在服务器上安装docker docker技术准备工 ...

  7. GitHub版本控制

    版本控制-GitHub 前面几篇文章,我们介绍了Git的基本用法及Git服务器的搭建,本篇文章来学习一下如何使用GitHub.GitHub是开源的代码库以及版本控制库,是目前使用网络上使用最为广泛的服 ...

  8. asp.net core webapi/website+Azure DevOps+GitHub+Docker

    asp.net core webapi/website+Azure DevOps+GitHub+Docker 新春开篇作,主要写一下关于asp.net core web/api 2.2 项目借助dev ...

  9. Github和Azure DevOps的代码同步

    [前言]Github和Azure DevOps都提供了Git代码库功能,那么有没有办法将两边的代码库进行同步呢,答案是肯定的.这里的操作我都是用Azure DevOps的Pipelines功能来完成的 ...

随机推荐

  1. CSS中关于linebox的baseline位置移动的理解

    前言 最近看到一篇文章,弗里得木的翻译笔记,里面有个问题没有解决,就是linebox的baseline为什么会移动呢? 在讨论这个问题之前读者需要对 默认值baseline 以及 其他属性值(天镶的博 ...

  2. ezdpl:完全依赖脚本和ssh的自动化部署方案

    ezdpl是easy deployment的简写,使用简单的ssh和shell脚本来部署.升级.回滚和重新配置linux服务器. 重要提示:警告:这个项目还处于测试过程中,请仔细阅读说明,并且自己承担 ...

  3. 破解Power Designer 12.5

    PowerDesigner15.1破解补丁链接: https://pan.baidu.com/s/1boJoT6B 密码: 9x77 解压,将文件 pdflm15.dll替换安装目录的同名文件即可.

  4. 三大集合框架之Set

    Set介绍 Set相对于List.Map是最简单的一种集合.集合中的对象不按特定的方式排序,并且没有重复对象. 特点: 它不允许出现重复元素: 不保证和政集合中元素的顺序 允许包含值为null的元素, ...

  5. Eclipse集成Maven(手工安装Maven且手工集成到Eclipse)

    1.操作环境 操作系统:win8 64位 IDE:Helios Eclipse 1.8 JDK:1.6 2.资源准备 2.1 maven安装包: apache-maven-3.2.5-bin.zip  ...

  6. 为什么使用中间件下载时总是收到警告消息Object is in status Wait

    在使用中间件从ERP下载对象时,正常情况下应该看到如下提示消息: 然而有时遇到的是黄色的警告消息:Object is in status Wait. 如何自己排错呢?在函数SMOF0_INIT_DNL ...

  7. IT人们给个建议

    开篇声明:我本身是中学老师,师范类大学计算机专业毕业,现在马上研究生学位就要拿上了,平时在学校搞网络维护什么的,事少,业余时间充足,也不想拘泥于做老师拿点工资,觉得白学计算机了,所以也搞些业余开发,如 ...

  8. vue.js--基础 事件结合双向数据绑定实现todolist,增加和删除功能

    原理很简单,写一个input框,定义一个空的list,当在input中增加数据时,就往list中添加数据,然后在循环这个list的数据,删除数据就是调用list中的splice <templat ...

  9. Python语言程序设计基础(7)—— 文件和数据格式化

    返回字符串 file = input() #返回字符串 fo = open(file,"r").read(6) print(fo) 返回列表形式 file = input() fo ...

  10. POJ 1379 模拟退火

    模拟退火算法,很久之前就写过一篇文章了.双倍经验题(POJ 2420) 题意: 在一个矩形区域内,求一个点的距离到所有点的距离最短的那个,最大. 这个题意,很像二分定义,但是毫无思路,也不能暴力枚举, ...