https://github.com/johannchopin/stackoverflow-readme-profile
Easily share your Stackoverflow's profile on your README
https://github.com/johannchopin/stackoverflow-readme-profile
badge profile readme reputation stackoverflow
Last synced: about 1 month ago
JSON representation
Easily share your Stackoverflow's profile on your README
- Host: GitHub
- URL: https://github.com/johannchopin/stackoverflow-readme-profile
- Owner: johannchopin
- License: agpl-3.0
- Created: 2021-05-07T12:58:07.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T20:40:33.000Z (5 months ago)
- Last Synced: 2025-03-08T14:32:15.682Z (about 1 month ago)
- Topics: badge, profile, readme, reputation, stackoverflow
- Language: Svelte
- Homepage: https://stackoverflow-readme-profile.vercel.app/
- Size: 7.96 MB
- Stars: 47
- Watchers: 1
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-github-profile - Stackoverflow Readme Profile
README
# stackoverflow-readme-profile
Easily share your Stackoverflow's profile on your README.
---
## [➡️ Get your profile badge](https://stackoverflow-readme-profile.vercel.app):
💡 How to use?
> Use the [online generator](https://stackoverflow-readme-profile.vercel.app/profile) for a quicker setup
You can generate your SO profile by calling this url with the corresponding [template name](#templates) and your SO user id:
```
https://stackoverflow-readme-profile.johannchopin.fr/:template/:id
```
Use it like that in your README:
```md
[](https://github.com/johannchopin/stackoverflow-readme-profile)
```
---
### 📄 Templates
- [profile](#profile)
- [profile-small](#profile-small)
#### profile
Render a profile badge by using the `profile` template:
```
https://stackoverflow-readme-profile.johannchopin.fr/profile/:id
```
##### Params (as query strings)
| param | default | description |
| :--------- | :-------: | :------------------------------------------------------------- |
| `theme` | `default` | Theme to use. [Check them out here!](./docs/profile/README.md) |
| `website` | `true` | Show or not the website URL (`true` \| `false`) |
| `location` | `true` | Show or not the location (`true` \| `false`) |
#### profile-small
Render a smaller profile badge without the location and the website
##### Params (as query strings)
| param | default | description |
| :------ | :-------: | :------------------------------------------------------------------- |
| `theme` | `default` | Theme to use. [Check them out here!](./docs/profile-small/README.md) |
---
## [➡️ Get your ranking badge](https://stackoverflow-readme-profile.vercel.app):
💡 How to use?
> Use the [online generator](https://stackoverflow-readme-profile.vercel.app/tags-league) for a quicker setup
You can generate your SO ranking badge by calling this url with the desired technology ([see the tags list](./src/tags-league/TAGS.json)) and your SO user id:
```
https://stackoverflow-readme-profile.johannchopin.fr/tags-league-ranking/:tagName/:id
```
### Params (as query strings)
| param | default | description |
| :------ | :-------: | :------------------------------------------------------------------------- |
| `theme` | `default` | Theme to use. [Check them out here!](./docs/tags-league-ranking/README.md) |
## 🦄 Contributing
All remarks are welcome so feel free to [open an issue](https://github.com/johannchopin/stackoverflow-readme-profile/issues/new/choose) 😉
Wants to collaborate? Please read the [contributing guidelines](./CONTRIBUTING.md).
## 📄 License
[AGPL-3.0](./LICENSE.txt)