Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ivgtr/twitter-profile-card

🐣 Get dynamically generated Twitter Profile Card on your readmes!
https://github.com/ivgtr/twitter-profile-card

profile-readme readme-generator twitter

Last synced: 15 days ago
JSON representation

🐣 Get dynamically generated Twitter Profile Card on your readmes!

Host: GitHub
URL: https://github.com/ivgtr/twitter-profile-card
Owner: ivgtr
Created: 2021-01-19T05:59:57.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-12-19T19:58:26.000Z (about 3 years ago)
Last Synced: 2024-11-09T21:42:50.959Z (2 months ago)
Topics: profile-readme, readme-generator, twitter
Language: TypeScript
Homepage: https://twitter-profile-card.vercel.app/api
Size: 3.13 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


  

  Twitter Profile Card

  Get dynamically generated Twitter Profile on your readmes!



---

## Setup

Copy-paste this into your markdown content, and that's it. Simple!

Change the ?id= value to your Twitter's screen_name.

```md

[![Twitter Profile Card](https://twitter-profile-card.vercel.app/api?id=twitter)](https://twitter.com/twitter)

```

### Multiple color variations

Use ?color=COLOR_NAME or ?bgColor=COLOR_NAME parameter like so :

```md

[![Twitter Profile Card](https://twitter-profile-card.vercel.app/api?id=twitter&color=pink)](https://twitter.com/twitter)

```

```md

[![Twitter Profile Card](https://twitter-profile-card.vercel.app/api?id=twitter&bgColor=gradient)](https://twitter.com/twitter)

```

##### All inbuilt color variations :

`blue`, `yellow`, `pink`. `purple`, `orange`, `green`, `white`, `gradient`



### Multiple color mode

Use ?mode=MODE_NAME parameter like so :

```md

[![Twitter Profile Card](https://twitter-profile-card.vercel.app/api?id=ivgtr&mode=dark)](https://twitter.com/twitter)

```

##### All inbuilt color modes :

`normal`, `dark`, `darkBlue`



##### Currently, the color changes only slightly.

I'm not a designer so I'm hoping some of you can help me out.

### Experimental Support

##### Select font in [Google Fonts](https://fonts.google.com/).

- Use `?font=FONT_NAME` parameter like so.

default: `Noto Sans JP`

## Deploy on your own Vercel instance

Due to the API restrictions of Twitter, you need to deploy to Vercel yourself.

If there are few users, there is no need for you to do anything.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/ivgtr/twitter-profile-card)

## License

MIT ©[ivgtr](https://github.com/ivgtr)

[![Twitter Follow](https://img.shields.io/twitter/follow/ivgtr?style=social)](https://twitter.com/ivgtr) [![Github Follow](https://img.shields.io/github/followers/ivgtr?style=social)](https://github.com/ivgtr) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) [![Donate](https://img.shields.io/badge/%EF%BC%84-support-green.svg?style=flat-square)](https://www.buymeacoffee.com/ivgtr)