📚

GitHubのプロフィールにSNSのステータスを表示するサービスを作った

2024/08/25に公開

はじめに

こんにちはYamamoto(@evdMPDGElQtCL6o)です😆
この度はハッカソンで、GitHubのプロフィールにSNSのカードを表示できるアプリを作成したので、この場で軽くご紹介させていただけたらなと思います!

作ったもの

下記のように、READMEに各種SNSのカードを表示することができます。
現在は下記6種のみの対応ですが、今後さらに種類を増やしていく予定です。
Xが無いのは察してください...😭😭😭

リポジトリ

https://github.com/Teamsasa/github-sns-profile-card

使い方

詳しい利用方法は上記リポジトリのREADMEに記載してありますが、ざっくり説明すると、
下記のような形で画像を配置すると、自動的に生成されるようになっています。
タグは特に形式は問いません![]()などでも問題ないです。

# Zenn公式アカウント
<img src="https://github-sns-profile-card-e53bc5obaa-an.a.run.app/svg?platform=zenn&userid=zenn&width=300"/>

platformプロパティ

カードに表示させたいプラットフォームを選択します。

useridプロパティ

カードに表示させたいアカウントを選択します。

widthプロパティ(オプション)

ユーザー名が長くて切れてしまう場合などにこのプロパティを設定することで、カードの横幅を伸ばすことができます。
デフォルトは260が設定されているので、設定しない場合は自動的に内部で260に設定されています。

最後に

今回はREADMEにSNSのカードを表示するアプリを紹介させていただきました。
ぜひみなさんにも使っていただけると嬉しいです!!!
GitHubのプロフィールで有名なOSSだと、Github Profile Summary CardsやGitHub Profile Trophyなどありますが、これらに並ぶアプリケーションになれるように、これからも開発していきたいと思います。
最後まで読んでいただき、ありがとうございました!!

※ 「いいな」と思った方は、ハート❤️を押していただけると、READMEのカウントが増えて作者が喜びます。😆

Discussion