Warning
The old Deno API has been deprecated and will stop working soon (see Deno Deploy Classic shutdown).
Please update to the new API endpoint as soon as possible.
Add GitHub profiles to Markdown in a snap
Official instance: profilator.bellisario.tk
Are you using GitHub Profilator? Let us know on this discussion! 🚀
| Profile | Smooth Error |
|---|---|
You can also customize the scale of the Profilator (there are no step scaling limits, ex. you can also scale 0.67x)
| 1x scale | 0.75x scale | 0.5x scale |
|---|---|---|
Note
Scale is limited to 0.5x for visibility reasons.
Generate a new Profilator from the official website and while updating the markdown change it like this:
+ [](https://github.com/Bellisario)
- [](https://github.com/Bellisario)Tip
You can scale up to 3x.
If you want to force an username letter to be uppercase, just write the username with the letter in uppercase, Profilator will be able to parse it anyway and you'll see that in uppercase, too.
See the example below:
| lowercase | forced uppercase |
|---|---|
Under the hood, GitHub Profilator uses the GitHub API to fetch the profile data and then uses a pre-built template to generate the image, with the all the data needed.
This project uses Hono and Bun, with the option to deploy to Cloudflare Workers (used for the official instance).
The template is built with Figma (and then manually modified). You can find the .fig file here.
Because, as the description said, "you can add GitHub profiles to Markdown in a snap" and in a prettier format than the plain "ugly" table you see on a lot of repositiories:
 |
|---|
| Giorgio Bellisario |
To get started, clone, cd the repo and init the .env file:
git clone https://github.com/Bellisario/profilator && cd profilatorcp .env.example .envThen, you can run the following command to start the server:
bun run devYou can also run this command to start the server in production-like mode with Cloudflare Wrangler:
bun run startWhen you're done with the changes, run bun run format to make sure your changes follow the project formatting style.
Note
Depending on your Internet provider, you may need to create a GitHub access token and add it to your .env file to use GitHub API.
We ❤️ contributions!
Feel free to open an issue or a pull request but follow Contributing Guidelines.
MIT License here.