{"id":16495162,"url":"https://github.com/bellisario/profilator","last_synced_at":"2025-03-21T08:30:32.181Z","repository":{"id":45372875,"uuid":"512519967","full_name":"Bellisario/profilator","owner":"Bellisario","description":"Add GitHub profiles to Markdown in a snap","archived":false,"fork":false,"pushed_at":"2025-01-04T21:02:14.000Z","size":307,"stargazers_count":15,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T04:15:26.441Z","etag":null,"topics":["deno","deno-deploy","github","github-api","markdown","profile","profile-readme","typescript"],"latest_commit_sha":null,"homepage":"https://profilator.deno.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bellisario.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Bellisario"}},"created_at":"2022-07-10T19:19:43.000Z","updated_at":"2025-01-04T21:02:14.000Z","dependencies_parsed_at":"2023-10-14T18:32:32.398Z","dependency_job_id":"9845b6e6-3655-46a3-a1c4-8fa21a90f383","html_url":"https://github.com/Bellisario/profilator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bellisario%2Fprofilator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bellisario%2Fprofilator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bellisario%2Fprofilator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bellisario%2Fprofilator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bellisario","download_url":"https://codeload.github.com/Bellisario/profilator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244121311,"owners_count":20401250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deno","deno-deploy","github","github-api","markdown","profile","profile-readme","typescript"],"created_at":"2024-10-11T14:28:08.735Z","updated_at":"2025-03-21T08:30:31.221Z","avatar_url":"https://github.com/Bellisario.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Bellisario"],"categories":[],"sub_categories":[],"readme":"\u003c!-- cspell:word jamesbond --\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://profilator.deno.dev/@profilator?v=1.0.0.alpha.4\" align=\"center\"\u003e\u003c/img\u003e\u003c/center\u003e\n\u003cp\u003e\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eGitHub Profilator\u003c/h1\u003e\n\n\u003e Add GitHub profiles to Markdown in a snap\n\n\u003e **Warning**\\\n\u003e This is an _Alpha_ version of the project, and it is not stable yet.\n\n**Official website:** [https://profilator.deno.dev/](https://profilator.deno.dev/)\n\n\u003e Are you using GitHub Profilator? Let us know [on this discussion](https://github.com/Bellisario/profilator/discussions/1)! :rocket:\n\n## Example\n\n\u003c!-- deno-fmt-ignore-start --\u003e\n\n| Profile | Smooth Error |\n| ---- | ---- |\n| [![Bellisario's Profilator](https://profilator.deno.dev/Bellisario?v=1.0.0.alpha.4)](https://github.com/Bellisario) | [![@404's Profilator](https://profilator.deno.dev/@404?v=1.0.0.alpha.4)](https://github.com/@404) |\n\nYou can also customize the scale of the Profilator (there are no step scaling limits, _ex. you can also scale 0.93534...x_)\n| 1x scale | 0.75x scale | 0.5x scale |\n| ---- | ---- | ---- |\n| [![Bellisario's Profilator](https://profilator.deno.dev/Bellisario?v=1.0.0.alpha.4)](https://github.com/Bellisario) | [![Bellisario's Profilator](https://profilator.deno.dev/Bellisario?v=1.0.0.alpha.4\u0026scale=0.75)](https://github.com/Bellisario) | [![Bellisario's Profilator](https://profilator.deno.dev/Bellisario?v=1.0.0.alpha.4\u0026scale=0.5)](https://github.com/Bellisario) \n\n\u003e **Warning:** Currently scale cannot be below 0.5x (because Profilator will become invisible :ghost:)\n\n\u003c!-- deno-fmt-ignore-end --\u003e\n\n### How to use the scale option\n\nGenerate a new Profilator from [Profilator website](https://profilator.deno.dev/) and then when adding to markdown change it like this:\n\n```diff\n+ [![Bellisario's Profilator](https://profilator.deno.dev/Bellisario?v=1.0.0.alpha.4\u0026scale=0.75)](https://github.com/Bellisario)\n- [![Bellisario's Profilator](https://profilator.deno.dev/Bellisario?v=1.0.0.alpha.4)](https://github.com/Bellisario)\n```\n\n\u003e **Tip:** you can also scale more than 1x, for example 2x, but for now the image resolution is the same, so could be grainy\n\n\u003e **Warning:** Profile images over 3x will be rendered as 3x to prevent server bandwidth consumption too high and client heavy image downloads.\n\n### Other tips\n\n#### Force username letter uppercase\n\nIf 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.\\\nSee the example below:\n\n\u003c!-- deno-fmt-ignore-start --\u003e\n\n| lowercase | forced uppercase |\n| ---- | ---- |\n| [![jamesbond's Profilator](https://profilator.deno.dev/jamesbond?v=1.0.0.alpha.4)](https://github.com/jamesbond) | [![JamesBond's Profilator](https://profilator.deno.dev/JamesBond?v=1.0.0.alpha.4)](https://github.com/JamesBond) |\n\n\u003c!-- deno-fmt-ignore-end --\u003e\n\n## How it works\n\nUnder the hood, GitHub Profilator uses the GitHub API to fetch the profile data and then uses a [pre-built template](https://github.com/Bellisario/profilator/blob/main/assets/template.svg) to generate the image, with the all the data needed.\n\n## Technologies\n\nI decided to use [Deno](https://deno.land) for this project because it's a great tool for building simple and fast servers, with the help of the awesome [Deno Deploy](https://deno.com/deploy).\n\nThe template is built with Figma (and then manually modified) and you can find the .fig file [here](https://github.com/Bellisario/profilator/blob/main/assets/GitHub%20Profilator.fig).\n\n## Why should you use GitHub Profilator?\n\nThere is a simple answer to this question: like the description said \"you can add GitHub profiles to Markdown in a snap\" and I can also add you are able also to get a beautiful profile display for your GitHub profile, and not an \"ugly\" one like below (you can see on a lot of repositories):\n\n| [![Giorgio Bellisario](https://github.com/Bellisario.png?size=100)](https://github.com/Bellisario) |\n| -------------------------------------------------------------------------------------------------- |\n| [Giorgio Bellisario](https://github.com/Bellisario)                                                |\n\n## Development\n\nTo get started, clone the repo:\n\n```bash\ngit clone https://github.com/Bellisario/profilator.git\n```\n\nThen, you can run the following command to start the server:\n\n```bash\ndeno task dev\n```\n\nYou can also run the following command to start the server in production mode:\n\n```bash\ndeno task start\n```\n\n---\n\n**Warning:** You could need to create a new GitHub personal access token to use this server (especially if your IP Address is associated from GitHub as \"too many requests\").\n\n### To use a personal access token\n\nCreate a new one from [here](https://github.com/settings/tokens/new?description=GitHub%20Profilator%20DEV) (it requires no permissions).\n\nThen, you can set the token into a file named `.github_token` in the root of the project. You can also use the terminal like this:\n\n```bash\necho \u003ctoken\u003e \u003e .github_token\n```\n\nIf you prefer, you can also create a new environment variable called `GITHUB_TOKEN` and set it to the token, but this is not recommended for development use: it's only recommended if you want to use the server in production mode (for example) on [Deno Deploy](https://deno.com/deploy).\n\n## How to contribute\n\nFeel free to [open an issue](https://github.com/Bellisario/profilator/issues/new/choose) or a [pull request](https://github.com/Bellisario/profilator/pulls) but follow [Contributing Guidelines](https://github.com/Bellisario/profilator/blob/main/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbellisario%2Fprofilator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbellisario%2Fprofilator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbellisario%2Fprofilator/lists"}