Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kurt-liao/medium-story
Show your recent Medium stories on github readme.
https://github.com/kurt-liao/medium-story
github-readme javascript medium readme
Last synced: about 2 months ago
JSON representation
Show your recent Medium stories on github readme.
- Host: GitHub
- URL: https://github.com/kurt-liao/medium-story
- Owner: kurt-liao
- License: mit
- Created: 2022-06-27T16:09:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-01T00:50:08.000Z (over 2 years ago)
- Last Synced: 2024-10-10T17:41:15.902Z (2 months ago)
- Topics: github-readme, javascript, medium, readme
- Language: JavaScript
- Homepage: https://medium-story.vercel.app
- Size: 698 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Get recent medium stories on your README profile
# Medium Story Card
Easy to use! 🅲🆃🆁🅻+🅲 & 🅲🆃🆁🅻+🆅 into your readme markdown.
Change the `?username=` value to your Medium's username.
```md
[![My Medium Stories](https://medium-story.vercel.app/api?username=@s09001&index=0)](https://medium-story.vercel.app/api?username=@s09001&index=0&is_link=true)
```[![My Medium Stories](https://medium-story.vercel.app/api?username=@s09001&index=0)](https://medium-story.vercel.app/api?username=@s09001&index=0&is_link=true)
or
_Note: This project use rss to get your newest 10 stories. The `index` param let
you to choose which story you want to get, 0 means the latest story, etc._You can see an example **[here](https://github.com/kurt-liao/kurt-liao)** as well.
### Hide specific info
You can pass a `&hide=` parameter with comma-separated values.
> `&hide=date,img,desc,category`
```md
![My Medium Stories](https://medium-story.vercel.app/api?username=@s09001&index=0&hide=date,img)
```![My Medium Stories](https://medium-story.vercel.app/api?username=@s09001&index=0&hide=date,img)
### Get story url
You can pass a `&is_link=true`. Instead of return a svg image, the request will
return the link of story```
https://medium-story.vercel.app/api?username=@s09001&index=0&is_link=true
```## Deploy your own 🚀
Guide
- Fork this repo
- Sign up and log in into [Vercel](https://vercel.com/)
- Go to Vercel [dashboard](https://vercel.com/dashboard)
- Click `New Project`
- Click `Import Git Respository`(Of course you need to authorize the repo first,
then you can see the repo in the list)
![2022-06-30_10-28](https://user-images.githubusercontent.com/32745146/176579816-2a28f1d5-2fd2-4218-8367-01a53dfcc09a.png)- Click `delpoy`, and done. Find out your domain and start to use it!
- Add following command to prevent deploying on irrelevant changes.
![2022-06-30_10-17](https://user-images.githubusercontent.com/32745146/176579415-23ac711e-c695-4bad-aa85-1faf4ef67c67.png)---
Contributions welcome! Also ⭐