【Git】GitHub同名项目实现丰富多彩的README.md
文章目錄
- 導讀
- 徽章圖片
- Emoji
- 數據統計
- 貪吃蛇
導讀
README.md作為Markdown文件,GitHub支持了Markdown的基本語法,但不支持CSDN提供的強大的公式編輯$$功能以及標題功能等。
看到別人的GitHub同名項目里README.md豐富多彩,你是否羨慕呢?本文給讀者分享幾種常見的裝飾README.md的小技巧,遇到新鮮的玩法會持續更新。
徽章圖片
Shields IO有豐富的圖片資源可以用在GitHub用戶的README.md中,Shields項目也已開源。
該項目以SVG和raster格式提供簡潔、一致和易讀的徽章的服務,可以輕松地包含在GitHub的README.md文件或任何其他網頁中。 該服務支持數十種持續集成服務、包注冊表、分發、應用商店、社交網絡、代碼覆蓋服務和代碼分析服務。每個月它提供超過7.7億張圖片,并被一些世界上最受歡迎的開源項目使用,如 VS Code、Vue.js 和 Bootstrap 等等。
比如:
Emoji
有很多可以提供Emoji圖片的網站,試推薦一個:emojipedia。
數據統計
github-readme-stats是一款非常有趣的GitHub數據統計可視化工具,也提供了中文文檔,可以在GitHub用戶的README.md里呈現出如下效果:
數據統計卡片有很多樣式,還支持漸變色:
支持自定義repo卡片:
支持熱門語言統計:
貪吃蛇
逛GitHub的時候發現了一個有趣的README.md內容,就是snack,容筆者稱其為“貪吃蛇”。
比如下圖為某GitHub用戶的contributions統計:
通過一系列的操作,呈現在README.md上的是一個SVG格式的貪吃蛇動圖:
操作方法如下:
將以下yml內容填入以后點擊“Start Commit”,注意填寫用戶名:
name: Generate Datason:schedule:- cron: "* */12 * * *"workflow_dispatch:jobs:build:name: Jobs to update datasruns-on: ubuntu-lateststeps:# Snake Animation- uses: Platane/snk@masterid: snake-gifwith:github_user_name: 你的用戶名svg_out_path: dist/github-contribution-grid-snake.svg- uses: crazy-max/ghaction-github-pages@v2.1.3with:target_branch: outputbuild_dir: distenv:GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}通過以上方法生成了SVG文件,README.md引入方法就是:

兩個“你的用戶名”都是為了湊URL,第一個是你的用戶名必須要有,第二個是你的repo一般是同名repo,所以需要填這個。
總結
以上是生活随笔為你收集整理的【Git】GitHub同名项目实现丰富多彩的README.md的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【解惑】这么多技术我该怎么学
- 下一篇: 作者:黎建辉(1973-),男,博士,中