首页
学习
活动
专区
圈层
工具
发布

给库加上酷炫的小徽章 & ava、codecov、travis 示例

GitHub 很多开源库都会有几个酷炫的小徽章,比如: ? 这些是怎么加上去的呢? Shields.io 首先这些徽章可以直接去 shields.io 网站自动生成。...当然还有其他很多徽章都任由你挑选,不过某些徽章是需要额外进行一些配置,比如这里的 build passing (自动构建通过)和 coverage 72% (测试覆盖率)。...sudo : 声明在 CI 的虚拟环境中是否需要管理员权限。 before_install : 安装额外的系统依赖。...由于我们在 travis-ci 上执行 npm run report-coverage 向 codecov 上报测试覆盖率时需要其权限,因此还需要在 travis-ci 的 Settings 中设置环境变量...结语 shields.io 徽章有多种,根据你的需要进行相应的配置即可,本文使用了 codecov 和 travis-ci 作为示例,但是还有很多其他的平台任由你选。

1.4K30

GitLab 冷知识:妙用 Badge 徽章

前言 在前一篇文章 《GitLab 冷知识:如何美化 issue 内容》[1] 中就有介绍自定义 Badge的使用方式。...实际上 GitLab 本身就提供了一些实用的 Badge 以及专门的 Badge 展示位置和配置,本文就介绍一些 GitLab 自带 Badge 的使用以及一些 Badge 的妙用。...同时还提供了变量[2]以供用户填入通用值,这里的 Badge 也是可以展示 shields.io[3] 中各种自定义 Badge 样式的。...逻辑上 coverage 只是抓取了对应 CI Job 的 Log 值并通过正则表达式将其提取出来,如果您打印的值格式是自定义的,就需要调整 coverage 中的正则表达式。...":{"counts":{"all":882,"closed":531,"opened":351}}} 之后只需使用 jsonpath 来获取 opened 中的值即可,可以使用 jsonpath.com

2.2K31
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    如何做好一个开源项目之徽章(二)

    在上一篇如何做好一个开源项目(一),笔者已经介绍过开源项目运作和维护的一些理念了,本篇开始,笔者将着重于介绍一些开源项目维护过程中的一些细节,比如徽章、构建等等。...该徽章使用 http://shields.io/ 进行添加,我们可以在该网站预览绝大部分的徽标样式,然后选择自己喜欢的(当然首先需要适用于自己的目标项目)徽标,添加到自己的项目文档中。...打开网站:http://shields.io/,我们就可以看到各种各样的徽章设置: ?...如下图Magicodes.IE的徽章所示,如何添加这些徽章呢? ? CI的徽章是很有必要的,一目了然的了解了项目的代码覆盖率、构建状态和单元测试状况,那么如何来装这个B呢?...这个就需要看CI平台了,基本上都提供了渠道。比如Azure DevOps: ? 代码覆盖率、单元测试状况呢?这个就要回到刚才的Shields站点了: ? ? 如何添加贡献者的徽章?

    76620

    Github主页美化-基础构建

    ),在这个过程中不仅可以根据自身需要定制化主页以满足强迫症调调,还可在这个过程中探索到许多好玩的扩展和应用,例如常见的github基本操作、Github Actions、Python爬取并处理数据、个人博客信息嵌入...此外github上一些开源的公共仓库也收录了不同的主页作者信息例如awesome-github-profile-readme,awesome-github-profiles。...[图片说明](图片链接URL) # 或者在图片基础上嵌套URL链接跳转 [!...5k次请求,因此使用其提供的API可能有访问限制,因此可以自行部署在自己的Vercel服务器上,参考部署 GitHub Readme Activity Graph [GitHub Readme Activity...[BADGE-图徽(shields.io)] ​ BADGE-图徽(shields.io) 静态徽章图标生成 动态统计徽章图标生成 # 参考URL(logo可指定图标内容) !

    1.6K20

    一看就会的 GitHub 骚操作,让你看上去像一位开源大佬

    [image-20210409141302396.png] 那问题来了,我主页上的一些 个人统计卡片 是怎么做的呢?...[image-20210409142426078.png] 小徽章 GitHub 上很多知名项目的介绍页中,总能看见许多小徽章,比如阿里的 Ant Design: [image-20210409151323713...那这个是怎么做的呢? 可以使用这个项目:Shields.io 地址:https://shields.io/ 它可以为你的开源项目生成高质量小徽章图标,直接复制链接使用。...[image-20210409150703091.png] 除了 Shields.io 外,还有一个专门生成 访客数徽章 的项目,直接将一行代码粘贴到 README.md 文件中就能使用。...项目:All Contributors 地址:https://allcontributors.org/ 这个项目,允许你使用命令行或者机器人的方式自动将项目的贡献者补充到项目文档中,并且生成排版精美的表格

    2K52

    工具资源系列之 github 上各式各样的小徽章从何而来?

    不仅出现于 github 项目主页,凡是能够表现图片的地方都可以出现徽章,本质上是一种 svg 格式的矢量图标....如何使用徽章 大多数徽章都是 svg 格式,当然也不排除某些徽章是 png 格式,不论怎么说,一律当成图标使用就可以了....如果你和我一样,希望在 markdown 文件中使用徽章,那么建议使用在线链接,或者引入本地 svg 相关文件. > 徽章格式 : [!...徽章有不同的分类,不管是哪种分类,在线徽章最为简单便捷,下面就简单介绍下提供在线生成徽章的网站. https://shields.io/ https://badgen.net/ https://forthebadge.com...如果徽章的主题明确,那么根据网站提供的主题对号入座即可在线生成徽章,下面以 gitbook-plugin-mygitalk 为例,简要说明如何获得相应徽章链接. > gitbook-plugin-mygitalk

    2.9K60

    工具资源系列之 github 上各式各样的小徽章从何而来?

    不仅出现于 github 项目主页,凡是能够表现图片的地方都可以出现徽章,本质上是一种 svg 格式的矢量图标....如何使用徽章 大多数徽章都是 svg 格式,当然也不排除某些徽章是 png 格式,不论怎么说,一律当成图标使用就可以了....如果你和我一样,希望在 markdown 文件中使用徽章,那么建议使用在线链接,或者引入本地 svg 相关文件. 徽章格式 : [!...徽章有不同的分类,不管是哪种分类,在线徽章最为简单便捷,下面就简单介绍下提供在线生成徽章的网站. https://shields.io/ https://badgen.net/ https://forthebadge.com...如果徽章的主题明确,那么根据网站提供的主题对号入座即可在线生成徽章,下面以 gitbook-plugin-mygitalk 为例,简要说明如何获得相应徽章链接. gitbook-plugin-mygitalk

    2.8K50

    如何拥有一款有特色的 Github Profile?

    什么是 Github Profile Github Profile 用于展示个人的一些成果,把 Markdown 转换为 HTML 渲染在个人主页上,并且高度支持自定义。...Badge(徽章)[4] 推荐大家直接利用 shield.io[5] 做徽章自定义,能力非常强大,大部分开源项目 README 里的 badge 都是通过此网站生成的。...Dev Metrics(开发指标)[8] 在你的 Github Profile 上以酷炫可视化的方式展示一些开发指标。支持 Profile 动态定时更新。...后面会使用「在 Profile 中展示自己的关注者」这一示例,来解析动态更新的原理及源码实现。 3....const startPart = readmeData.slice(0, startIndex); const endPart = readmeData.slice(endIndex); 接着使用环境变量中的

    93110

    【github】快速使用指南基本操作高阶技巧ToDo参考资料

    对本地git仓库文件进行增、删、改、分 执行完以上操作后tmp目录就是一个git仓库了,你可以在其中新建、编辑文件 main.cpp , head.h等文件,但是此时新建、编辑文件 main.cpp...git clone git@github.com:keloli/GitConnectTest.git命令可以将github上的对应项目(这条命令就是GitConnectTest这个项目)全部克隆到本地...在本地删除文件并同步到远程仓库的方法 高阶技巧 在打开的页面可以敲 t ,然后就可以输入文件名进行筛选了 添加徽章 进入http://shields.io/ 选择合适的徽章,点击进入编辑页面...将对应的徽章地址复制到自己的README.md文档中 ?...徽章的5种styel的显示效果 当然,你也可以让徽章链接到指定网站,如https://github.com/keloli/NoteBook Wiki Wiki页面可以用来写更为详细的文档 给

    82810

    一文带你写好:项目说明文档README.md

    1、前言 公开项目中,一个好的 README 能帮助我们的公开项目,在 GitHub 上的众多项目和开发人员中脱颖而出;商业项目中,一个好的 README 能帮助部门同事更好理解用途和项目进展。...4.1.5 如何使用项目 提供项目说明和使用案例,以便用户/贡献者可以使用该项目,这将使他们始终有一个地方可以参考预期的内容。...如果我们在选择许可证方面需要帮助,请查看此链接:https ://choosealicense.com/ 4.1.8 徽章贡献 徽章不是必需的,但使用它们是让其他开发人员知道您知道自己在做什么的简单方法...下面是一个项目的屏幕截图,显示了如何使用徽章: 这个部分的好处是它会自动更新。 不知道从哪里得到它们?查看shields.io托管的徽章。他们有大量徽章可帮助您入门。...4.1.10 测试用例 为项目必要的应用程序编写测试,并提供代码示例以及如何运行它们。 这将有助于表明项目可行性,并避免一些质疑项目的挑战,提高使用者的信心。

    3.5K10

    怎样让开源项目看起来“高大上”

    作为开源项目的开发者,当然是希望自己写出来的成果能被更多的人尝试使用,所以这篇文章主要谈一谈怎样让开源项目看起来“高大上”,从而让别人有使用的冲动。...在我个人看来,一个“高大上”的 Github 上的开源项目应该满足这些条件: 一句话说明项目的功能; 有相对完善的测试用例和较高的代码覆盖率; 通过徽章明确地指出项目的兼容性、最新版本、被使用情况、License...由于开源项目迭代速度较快,而且经常会收到别人的 pull request,所以如何在快速迭代中,保持较高的质量成为了一个重要的问题。...我们也可以通过持续集成的方式,在 .travis.yml 文件中添加相关字段的说明,从而在 codecov 等网站上自动检测 diamante 覆盖率,从而再领取一枚徽章。 个性化的徽章 ?...这里强烈推荐 http://shields.io/ 这个网址,通过它,我们可以为项目添加上各种各样的徽章,例如: 项目的最新版本; 项目的被使用情况; 项目的兼容情况; 测试是否通过以及代码覆盖率情况;

    80910

    怎样让开源项目看起来“高大上”

    为了避免重复造轮子 ,我们往往会借助开源的项目实现一些功能。很多时候,选择使用哪一个开源项目就像选择男、女朋友一样,固然内在很重要,但是眼缘也很关键,只有看对了眼,才会进一步地了解。...在我个人看来,一个“高大上”的 Github 上的开源项目应该满足这些条件: 一句话说明项目的功能; 有相对完善的测试用例和较高的代码覆盖率; 通过徽章明确地指出项目的兼容性、最新版本、被使用情况、License...由于开源项目迭代速度较快,而且经常会收到别人的 pull request,所以如何在快速迭代中,保持较高的质量成为了一个重要的问题。...我们也可以通过持续集成的方式,在 .travis.yml 文件中添加相关字段的说明,从而在 codecov 等网站上自动检测 diamante 覆盖率,从而再领取一枚徽章。...这里强烈推荐 http://shields.io/ 这个网址,通过它,我们可以为项目添加上各种各样的徽章,例如: 项目的最新版本; 项目的被使用情况; 项目的兼容情况; 测试是否通过以及代码覆盖率情况;

    87040

    科学软件十条简单编程原则

    此外,您应该在自述文件中包含快速入门指南(如规则3中所述)。 通常,自述文件顶部会包含徽章,这些徽章在呈现时会显示软件的状态。徽章的一个常见来源是shields.io,它可以为您的项目动态生成徽章。...然而,CLI软件面临的一个挑战是很难弄清楚如何使用。记录CLI的最佳方法是使用“帮助”命令打印出如何使用该软件。这样,用户无需尝试查找文档即可完成基本任务。...如果没有其他原因,那么为了避免为用户提供技术支持(大多数人几乎没有阅读过您的文档,如果有的话),他们遇到了容易修复的使用错误。...在您的文档中包含引文信息对于尚未在传统学术期刊上发表的软件尤其重要,因为该期刊会为其分配DOI。仅仅因为您的软件未发布并不意味着您无法获得DOI - 您的工作值得信赖。...两者都为您的自述文件提供徽章(参见规则4),以便整个世界可以一目了然地告诉您如何引用您的软件。

    1.1K20

    怎么写一个超棒的README文档

    这些被称为徽章,它们通过提供一些快速见解提高了可读性,对吗? 你可以在你的项目中使用无数徽章,而且它们确实取决于项目。下面是我在每个项目中常用的一些。 我使用Shields IO网站制作徽章。...这是一种简单易用的工具,你可以使用几乎所有的徽章: https://shields.io ?...第一个问题应该是如何安装(如何使用项目或如何在机器中启动编辑)。 这里应该给用户详尽的想法,并说明他们如何使用项目repo的所有步骤。 按照以上步骤,他们应该能够在自己的设备中运行它。...这也显示了如何在节中添加子节。 赞助 你的项目备受青睐,并且已经被成千上万的人使用(有了这个README文件,将会有更高使用量)。现在,是时候寻找人员或组织来赞助你的项目了。...你可以在此部分中添加人们如何赞助你的项目。在此处添加你的patreon或GitHub赞助商链接,以方便访问。 一个好主意是还要向赞助商展示他们的组织徽标或徽章,向他们表达你的爱!

    2K30

    一篇文章,搞定五种类型的UI通知栏设计

    用户检查更新后,徽章会从应用程序图标中消失,并在新通知到达时再次出现。 右上角带有圆点的铃铛是此类通知的常规设计。 优点: 徽章不需要用户过多关注。徽章不会阻止用户与产品交互。...它可以对用户产生积极的影响。在某些情况下,用户可以将徽章视为有价值的奖励。例如,徽章会通知用户他们在社交网络上收到的新点赞。Nir Eyal 在他的书“Hooked”中描述了这种心理效应。...这可能不是很方便,尤其是当您与移动设备上的应用程序交互时。 何时使用: 您想要使用电子邮件通知有两个原因。...由于 toast 会在短暂超时后消失,因此某些用户可能无法阅读错误消息。 不要使用 toast 通知来提供有关如何使用应用程序的随机提示。...小心敏感信息 不要在通知中包含敏感信息。您无法预测人们在收到通知时会做什么,因此最好避免在设备屏幕上包含其他人可以看到的机密信息。

    4K20

    手把手教你用vuepress搭建自己的网站(4)

    部署到github平台 前提条件 文档放置在项目的 docs目录中 使用的是默认的构建输出位置 VuePress 以本地依赖的形式被安装到你的项目中,并且配置了如下的npm scripts:,然后在itclan...保持两个仓库的相互独立,互不干扰,如果全部放在一个仓库里,不易于后续维护和代码的管理 如果你想把代码静态资源部署到其他服务器上,你只需把build构建出来的dist文件放到你服务器根目录下就可以了的...'ga': '' // UA-00000000-0 ,填入你google账号分析那个ID即可 } ] ] 添加逼格徽章 有时候看到一些 Github 项目里,项目前会新填一些徽章,这些徽章是可以自己自定义生成的...使用的方式也很简单,使用 markdonw语法添加图片的方式引入到你md文件中就可以了的 !...[掘金](https://img.shields.io/badge/%E6%8E%98%E9%87%91-10K-orange) 链接地止徽章生成地止 shields.io https://shields.io

    1.3K31

    聊聊前端开发日常的协作工具(全)

    ,这里介绍的就是我使用的模版在线编辑工具 - 凡科快图 官方链接 或者 canva 官方链接 ❞ image.png image.png 1.6 Shields ❝ shields.io 主要是用来可以生成...在Markdown 文档中的徽章,我们经常在github的项目上看到这些徽章,来表述比如单元测试覆盖率、打包的大小、版本信息、认证信息等 官方链接 ❞ image.png 1.7 Gif生成...很长时间我要给当前网页截图,我还在用微信的截图工具,其实强大的chrome内置了截屏的功能,那如何使用呢 ❞ 首先打开chrome控制台(打开快捷方式 Option+Command+i) 打开命令行...,后者只是当前页面的截图 ❞ image.png 2.效率篇 ⏰ ❝ 在日常开发中,效率工具的使用,往往可以给我减少很多不必要时间的浪费,通过工具赋能,帮助我们提高生产效能 ❞ 2.1 Iconfont...- 兼容性测试工具 ❝ 上文提到web版本的caniuse,这里介绍下它的命令行工具,如何使用?

    1K43

    Add Github Badge

    github徽标 github徽标可以直接通过shields.io在线生成。 理论上可以放在页面的任何地方。教程案例是添加在页脚。...输入相关信息后,点击make badge即可得到徽标的URL。可以用img标签引用,写法简单。不过正式写法建议用object标签引用,写法示例如下。...拓展写法示例 在[Blogroot]\_config.butterfly.yml的footer配置项中添加徽标,注意事先压缩一下,使他们只留一行。...: ---- 外挂标签 考虑到对shields.io的全部参数支持,外挂标签使用object标签来引用。...css实现仿徽标样式 这一段参考自paddylin-Butterfly脚底自定义标签 在使用徽标时,偶尔会遇到需要在内部写入动态内容的情况,这时候再使用shields.io提供的标签就无法满足我们的需求了

    1.5K40
    领券