GitHub Readme Medium Card 📇
Get dynamically generated Meduim post cards on your readmes!
View Demo · Report Bug · Request Feature
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어
Loved the project? Please consider donating to help it improve!
Features
GitHub Medium Post Cards
Copy-paste this into your markdown content, and that's it. Simple!
Change the ?username= value to your Medium's username.
Themes
With inbuilt themes, you can customize the look of the card without doing any manual customization.
Use ?theme=THEME_NAME parameter like so :-
All inbuilt themes :-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
You can look at a preview for all available themes or checkout the theme config file & you can also contribute new themes if you like :D
Customization
You can customize the appearance of your medium cards however you want with URL params.
Common Options:
| Option | Default Value | Description | Required |
|---|---|---|---|
?username= |
"" |
Your Medium username | Yes |
&limit= |
10 |
Maximum number of medium post cards you want to show on your readme, all feeds combined | No |
&theme= |
light |
your medium blog post cards alignment could be any theme mentiond here. | NO |
Deploy on your own Vercel instance
Since the GitHub API only allows 5k requests per hour, my https://github-readme-medium-card.vercel.app/getMediumBlogs could possibly hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
Guide on setting up Vercel 🔨
- Go to vercel.com
- Click on
Log in - Sign in with GitHub by pressing
Continue with GitHub - Sign into GitHub and allow access to all repositories, if prompted
- Fork this repo
- Go back to your Vercel dashboard
- Select
Import Project - Select
Import Git Repository - Select root and keep everything as is, just add your environment variable named PAT_1 (as shown), which will contain a personal access token (PAT), which you can easily create here (leave everything as is, just name it something, it can be anything you want)
- Click deploy, and you're good to go. See your domains to use the API!
💖 Support the project
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.
However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-
- Giving proper credit when you use github-readme-medium-card on your readme, linking back to it :D
- Starring and sharing the project 🚀
- You can make one-time donations via PayPal. I'll probably buy a
coffeetea. 🍵
Thanks! ❤️
Contributions are welcome! <3
Made with ❤️ and JavaScript.
License
This project is licensed under the MIT License - see the LICENSE file for details
Reference
Most of the themes' color codes define from Github Readme Stats