Skip to content
31
layouts
45
block types
57
themes
What it does

What Profile README Studio does.

A GitHub profile README is the first thing people see on your profile, but writing one by hand means juggling markdown, HTML tricks and widget URLs. Most popular widgets are images from free community servers that get paused or overloaded, so cards break without warning.

Profile README Studio gives you ready layouts made of editable blocks and a preview that uses GitHub's own styles, and it draws every badge, banner, icon and card itself.

Pictures become files in your profile repository, and your stats cards are redrawn every day by one workflow in that repository, so no outside server can break them. It can also import the README you already have, so you do not need to start over.

Preview that matches GitHub

The preview uses GitHub's markdown styles and HTML rules, in light and dark mode, at desktop or phone width. What you see is close to what visitors will see.

Edit right on the page

Click a block in the preview to change its settings, double-click text to type into it, and drag blocks to reorder them.

Pictures that do not break

Badges, banners, tech icons and the typing line are drawn by the studio and saved in your profile repository. Stats, streak, trophies and the 3D graph are redrawn every day by one workflow in your repository, with its own token and no outside server.

Right cards in dark mode

The Auto theme wraps each card in a picture element with a light and a dark version, so every visitor gets the one that fits their theme. There are 57 themes in total.

Import what you have

Fetch your current README by username or paste it in. Known widgets turn back into editable blocks and everything else is kept as markdown.

Start from your details

Fill blocks from your public GitHub profile or from a resume PDF that is read in your browser, and review every change before it is applied.

From file to profile

How your README reaches GitHub.

A profile README is an ordinary README.md in a repository with a special name. The studio writes the file and links you straight to the right GitHub page to create or edit it.

  1. 01 · in the studioBuild it

    Pick a layout and edit it on the page. The studio draws every badge, icon and card, and Export gives you them as files with your README.

  2. you / youREADME.mdjust nowLICENSE
    02 · on GitHubA repository named like youyou/you

    Create a public repository with exactly your username as its name. The user octocat would create octocat/octocat.

  3. 03 · liveREADME.md at its rootyou/you/README.md

    Paste the export into README.md and upload its pictures, or publish both with a token. GitHub shows it at the top of your profile page, in light and dark.

For an organization, the README lives in the organization's public .github repository, in profile/README.md. The studio has organization layouts, a contributors wall and a hiring banner for it.

In a minute

See Profile README Studio in action.

A short video of Profile README Studio doing its one job, from an empty screen to the finished result.

Nothing loads from YouTube until you press play. Then Google receives your IP address and may set its own storage. Narrated with an AI-generated voice. Privacy
How it works

How to use Profile README Studio in three steps.

Best for: you want a modern GitHub profile README that looks right in light and dark mode, with no broken widget images, no outside servers and no hand-written HTML.

01

Pick a layout

Choose one of the 31 layouts, or import the README you already have.

02

Fill in the blocks

Type your username once, edit each block's small form, and switch the preview between light and dark to check both.

03

Export and publish

Download your README with its pictures, or publish them to your profile repository with a token, and add the one workflow that keeps your cards up to date.

Course

Learn Profile README Studio, from 0 to 100.

A free course of 12 short lessons, from your first minute in Profile README Studio to using all of it, with a picture of every step.

From the blog

Read more about Profile README Studio.

Every post

What's new

The latest release.

Latestv1.0.0First release

First release: build a GitHub profile README with a preview that matches GitHub

  • Profile README Studio builds the README at the top of your GitHub profile from 45 block types and 31 layouts (2 for organizations), with a preview that follows github.com's own styles in light and dark, at desktop or phone width.
  • Click anything on the page to edit it, type straight into headings, add a block in any of its ready-made styles, and reorder blocks by drag or keyboard in the Outline.
  • The studio draws every badge, logo tile, banner, divider, callout title, typing line (with its font inside) and tech stack icon itself. They become files in a profile-assets folder of your profile repository: Export downloads them all as a .zip, Publish for me commits them with a token you create.
  • Stats, top languages, streak, trophies, the activity graph, featured repos, gists, the contributors wall, the contribution snake, the 3D contribution graph, a Year overview and WakaTime are drawn by one workflow, profile.yml, in your own repository, with only GitHub's own actions. It also writes your recent activity and latest blog posts into the README, and an optional PROFILE_TOKEN secret adds your private commits, pull requests and issues as numbers.
Questions

Profile README Studio questions, answered.

How do I make a GitHub profile README?

Create a public repository with exactly the same name as your GitHub username and add a README.md file to it. GitHub then shows that README at the top of your profile page. For example, the user octocat would create the repository octocat/octocat. Profile README Studio writes the README.md for you and links to the right GitHub page to create or edit it.

Why are my GitHub stats cards not loading?

Most stats cards are images drawn by free community servers, and some of those servers are paused or rate limited because they share GitHub API limits. The studio draws its cards itself: a GitHub Actions workflow in your own profile repository redraws them every day with that repository's token, so no public server can break them. Import turns the cards of an old README into these.

Does the studio send my data to widget services?

No. The studio draws every picture in your browser and loads nothing from other sites, so no widget service sees you. It talks to GitHub only when you enter a username, fill blocks from GitHub, import, check your pictures, run the Profile Doctor or publish. Two optional blocks, the visitor counter and Spotify now playing, show pictures from their own services: the studio shows an example of them, and on your profile GitHub loads them through its image proxy.

How close is the preview to the real GitHub page?

Very close, because it uses GitHub's markdown styles and the same list of allowed HTML. Style attributes are removed just like on GitHub, and picture sources switch with the light or dark preview. Small differences can remain, such as code colours and emoji images.

Can I edit a README I already made somewhere else?

Yes. Import fetches your current README from GitHub or takes pasted markdown, turns known widgets into blocks and keeps the rest as markdown. READMEs made in the studio come back exactly, block for block.

What does the Profile Doctor check?

It scores a profile README out of 100 using 9 rules. These cover whether it says who you are, broken widget hosts, whether its pictures load from GitHub, dark mode, badge walls, contact details, showing your work, length and alt text. It can then open a fixed version next to the original, with the widgets drawn by the studio.

Can I make a profile for a GitHub organization?

Yes. There are organization layouts, a contributors wall and a hiring banner. An organization profile README lives in the organization's public .github repository, in the file profile/README.md.

Do I need an account, and where is my work saved?

No account is needed. Your layout autosaves in your browser, and the address bar always holds a link to it that you can share. Publishing with a GitHub token is optional, and the token is only sent to GitHub.

Is Profile README Studio made by one of the companies it names?

No. Profile README Studio is independent: it is not made, endorsed or supported by Anthropic, OpenAI, GitHub or any other company whose products it works with. Product names on this page are their owners' trademarks, used only to say what it works with.

Free, no sign-up

Try Profile README Studio now.

Profile README Studio is a free profile README builder that runs in your browser. You pick a layout, fill in simple forms, and see your README the way github.com will show it, in light and dark mode.

From the same shelf

More GitHub tools.

GitHub

Markdown Studio

Write Markdown and see it the way GitHub will show it, with a problems list, visual editing, Mermaid diagrams and HTML or PDF export.

About the toolOpens Jan 3
Contact