最近發現了好些非常有意思的 Github 個人首頁
。
比如這種,有展示
程式碼統計資訊
的:
或者這種,
自動追蹤
自己近期部落格、專案動態的:
還有和訪客
下五子棋
的:
GitHub 早在2020年就推出自定義首頁的功能了,這可能是作為程式設計師
最浪漫的
向全世界介紹自己的方式了。
如此炫酷的首頁,實現起來卻很簡單。下面是詳細的打造教程。
建立倉庫
第一步,新建一個倉庫,倉庫名必須和使用者名稱完全一致。
如果填寫正確,就會出現一個綠框,提醒你這個倉庫很特殊,會被作為自定義首頁使用:
倉庫必須設定為公共可見的(Public),並且勾選新增一個 README 檔案(Add a README file)。
建立完成後會自動跳轉到倉庫中,點選右上綠色的編輯按鈕(Edit README),或者灰色小鉛筆圖示,開始正式編輯首頁檔案。
排版
排版可以
同時
支援
Markdown
和
HTML
方式,也就是說你可以將這兩種排版形式混著用。
下面是 Markdown 的例子,左右分別是編輯和預覽模式:
可以看到 Emoji 表情也支援,直接複製貼上進去就 OK 了。
如果想要定製化更高的排版形式,那就用 HTML :
統計資訊
在 README 檔案中新增下面的程式碼,可以得到關於倉庫 Star 、提交、貢獻等
統計資訊
:
![Dusai‘s GitHub stats](https://github-readme-stats。vercel。app/api?username=stacklens)
你只需要將
username=
修改為你自己的 Github 名稱就行了。
得到類似這樣的卡片:
你還可以透過介面對卡片細節進行定製,比如我想要
顯示圖示
、
radical 主題
的卡片,程式碼修改為:
![Dusai’s GitHub stats](https://github-readme-stats。vercel。app/api?username=stacklens&show_icons=true&theme=radical)
結果如下:
更多的個性化配置項,可以檢視 github-readme-stats 專案文件:
徽標
相比於純文字,徽標顯得更顯眼,並且有助於你提煉關鍵詞,避免寫一堆口水話。
比如這位小哥,快被徽標給埋了:
徽標的生成很簡單,在 shields。io 網站上填你想要生成的內容就行了。
比如這個程式碼:
![](https://img。shields。io/badge/python-3。9-orange)
可以生成下面的徽標:
也可以透過介面修改外觀:
![](https://img。shields。io/badge/python-3。9-orange?style=for-the-badge&logo=python&logoColor=orange)
動態更新
展示
部落格近期文章
、
程式碼統計
這類動態追蹤的功能,就得稍微研究下
Github Actions
了。
首先進入 Waka Time 網站,用 Github 賬號登入,並在 settings/account/ 頁面取得金鑰(Secret API Key):
接著回到 Github 自定義首頁的倉庫,在 Settings/Secrets/ 中建立倉庫金鑰(Repository secrets),名稱是 WAKATIME_API_KEY ,內容則是上一步取得的 Secret API Key:
接著開啟倉庫的 Actions 新建一個
。yml
檔案,清空初始內容並寫入:
name: Waka Readmeon: workflow_dispatch: schedule: # Runs at 12am UTC - cron: “0 0 * * *”jobs: update-readme: name: Update this repo‘s README runs-on: ubuntu-latest steps: - uses: athul/waka-readme@master with: WAKATIME_API_KEY: ${{ secrets。WAKATIME_API_KEY }}
這段的意思就是設定了一個定時任務,每天 UTC 時間12點,WakaTime 將動態更新你的首頁 README 檔案。
最後,在 README 檔案中想要插入程式碼統計的位置,新增一個標誌位:
<!——START_SECTION:waka——><!——END_SECTION:waka——>
這就大功告成了。
顯示結果大致像這樣:
Python 8 hrs 52 mins ███████████████████░░░░░░ 75。87 %Go 1 hr 15 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 10。79 %Markdown 52 mins █░░░░░░░░░░░░░░░░░░░░░░░░ 07。43 %Docker 16 mins ░░░░░░░░░░░░░░░░░░░░░░░░░ 02。32 %YAML 7 mins ░░░░░░░░░░░░░░░░░░░░░░░░░ 01。07 %
總結
以上就是 Github 自定義首頁的基本玩法了。如果你想搞些更花哨的(比如下象棋),那麼可以參考 awesome-github-profile-readme ,裡面有很多有創意的首頁,並且都是開源的,你可以把喜歡的內容直接“借鑑”過來。
有了漂亮的首頁後,你還有什麼理由不多擼程式碼呢?
趕緊動起來,展示自己,給世界和未來的老闆看吧!