专栏首页彭湖湾的编程世界【github】论怎么去写一个高大上的ReadMe

【github】论怎么去写一个高大上的ReadMe

前言

以前我时常觉得,自己写的ReadMe很单调乏味,但后来仔细研究一下后,发现有很多方式可以让ReadMe在简洁的基础上变得好看些,所以在这里和大家分享,如果大家有更好的想法,也非常欢迎在评论区留言哦

美化方案

  • 加彩色徽章:介绍npm版本,证书类型,发布版本等
  • 给代码添加颜色,不要使用纯文本啦!
  • 给自己的代码库设计一个专属的logo
  • 有想到再加其他的

最终结果

Github地址

https://github.com/penghuwan/water.js​github.com

Act1. 加彩色徽章

大家可能会感到奇怪,下面这些彩色徽章哪里来的呢?

其实它们都来自这一个网站:https://shields.io/

打开网站,往下翻,可以看到几个输入框,如下所示

比如我们想要生成license MIT这样的徽章,就分别在label和message上填写,同时选择颜色,最后点击Make Badge

点击Make Badge后会跳转到一个打开的图标文件,这个地址就是图片的引用地址

然后我们只要把这个地址复制到ReadMe上写成图片就好了,比如

![](https://img.shields.io/badge/license-MIT-blue)

看到的结果

Act2. 加代码颜色

我们知道,我们可以用下面的Markdown标记添加代码块

``` 代码 ```

但如果仅仅这样,代码是没有颜色的,就像这样

如果我想加上颜色,我可以这么做: 给```后面加上语言名简写,比如:js

```js 
代码 
```

然后代码就被赋予颜色了呀(灵魂)

同理,python的代码颜色可以这样设置

```python 
#!/usr/bin/python3 
print("Hello, World!"); 
```

其他语言也是一样的,大家自己替换上去就好了

设计logo的网站很多,一查就有,随便你用哪个,但是我用过的设计最好,体验最好的还是下面这个Canva

https://www.canva.cn/design/DADk291IBFw/xK_s33mJsndiCPk03TYleQ/edit

可以给自己设计图标,名称和介绍,这下面是我的使用过程

效果如下

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • CVPR2019 论文:NAS-FPN: 基于神经架构搜索的FPN

    为了寻找到更优的FPN,论文中提出了利用神经架构搜索(NAS),NAS在给定的搜索空间中选择最佳的模型结构训练控制器。这个过程使用的了强化学习技术,控制器用子模...

    CV派
  • 2018 CCF《套餐个性化匹配模型》(亚军)分享

    PandasCute/2018-CCF-BDCI-China-Unicom-Research-Institute-top2​github.com

    机器学习理论与数据竞赛实战
  • 搭建自己的技术博客系列(六)酷炫主题icarus常用配置整合版,快速搞定博客首页

    这里首先要知道在 Hexo 中有两份主要的配置文件,其名称都是 _config.yml,它们均是用于站点配置使用的。其中,一份位于站点根目录下(比如我的:D:\...

    黄小斜
  • 搭建自己的技术博客系列(一)使用 hexo 搭建一个精美的静态博客

    https://github.com/ppoffice/hexo-theme-icarus

    黄小斜
  • 搭建自己的技术博客系列(二)把 Hexo 博客部署到 GitHub 上

    git config --global user.email "youremail"

    黄小斜
  • 版本分支管理标准 - Trunk Based Development 主干开发模型

    之前分享过《版本分支管理标准 - Git Flow》,不过在实际使用过程中, 因为其有一定的复杂度,使用起来较为繁琐,所以一些人员较少的团队并不会使用这个方案。

    用户1172223
  • 搭建自己的技术博客系列(三)让你的博客拥有评论功能!

    本来hexo博客用的是gitment,我也非常喜欢,看着逼格就超高呀。无奈我用着bug略多,而且毕竟有github账户的小伙伴似乎并不多。于是我就忍痛准备换评论...

    黄小斜
  • 每个 Java 开发人员都应该知道的 10 个基本工具

    大家好,我们已经在 2019 年的第 9 个月,我相信你们所有人已经在 2019 年学到了什么,以及如何实现这些目标。我一直在写一系列文章,为你提供一些关于你可...

    淡定的蜗牛
  • GitHub 上能挖矿的神仙技巧 - 如何发现优秀开源项目

    GitHub 有时比 Google 还有用,如果你不懂如何使用它来挖矿,那你不算一名合格的程序员。

    夜尽天明
  • git --- ! [rejected] master -> master (non-fast-forward)

    3.出现错误的主要原因是github中的README.md文件不在本地代码目录中

    小蔚

扫码关注云+社区

领取腾讯云代金券