Profile README Studio: build your GitHub profile README

Your profile README

Built from the blocks on the left; the preview shows it as github.com does.

Edit right on the page. Click a block to open its settings, double-click a heading or line to type into it, drag cards or rows to move them, and drag the blue handle on a card to resize it. Your username and colours are under Page settings.
Widgets show octocat until you add your GitHub username.
octocat/README.md

Add a block

Preview with your username, theme and colour mode. Every option can be changed after you add it.

Start from a layout

Applying a layout replaces your blocks. Your username and name stay. You can undo with Ctrl Z.

Import your current README

Reads raw.githubusercontent.com/<user>/<user>/main/README.md (then master) straight from your browser.

Your name, summary, links, skills, experience and certifications, ready to review. The PDF is read in your browser and never uploaded.

A .json file from Save layout file in Export: every block and setting, exactly as you left them. You can also drop it on this window.

Known widgets (stats, streak, trophies, skill icons, typing lines, badges, pin cards) become editable blocks, drawn by the studio from then on. Everything else is kept as markdown blocks, nothing is thrown away.

Put it on your profile

    Publish for meadvanceduses a GitHub token you create
    Keep a copy of your workSave every block and setting as a file, to back it up or open it on another computer with Import.

    Profile Doctor

    Type a username. The doctor reads the profile README, checks it against nine rules and scores it out of 100. Then it builds a fixed version you can open here in the studio.

    Or paste a README instead

    Reads raw.githubusercontent.com and api.github.com from your browser. Nothing is stored anywhere else.

    How the score works

    Nine rules share the 100 points: says who you are (15), no broken widget hosts (15), pictures load, from github (15), looks right in dark mode (10), no badge wall (10), easy to reach (10), shows your work (10), short enough to read (10) and images have alt text (5). Pictures on GitHub are loaded in your browser to time them; pictures from other servers are counted, not loaded. Think a rule is wrong or missing? Suggest a change.

    The fixed version moves widgets off servers that shut down, gives cards a light and a dark version, turns technology badge walls into one row of icons, adds alt text and, where your README is missing them, fills in your bio, links and top repositories from your public GitHub profile. Everything else is kept as you wrote it.

    Fill from your GitHub profile

    Read from your public profile at api.github.com, straight from your browser. Changes you have made yourself are not ticked, so nothing of yours is replaced unless you tick it.

    Write with AI

    Open Claude Open ChatGPT

    Nothing is sent anywhere until you paste the prompt into an assistant yourself.

    Use your own Anthropic API key optional

    With a key from console.anthropic.com, Write it for me writes the text right here. Your Anthropic account pays for it (a few cents at most). The key goes only to api.anthropic.com. Anthropic is in the USA: your key and text go there under your own agreement with Anthropic, without the protection EU law gives data kept in the EU.

    Keyboard shortcuts

    Click on the pageSelect a block and edit it in the settings on the right
    Double-click textType straight into a heading, line or bullet
    EscBack to the page settings
    ASearch the blocks to add
    Drag from Add blocksDrop a new block exactly where you want it on the page
    Drag a card on the pageDrop it beside another card, or above or below a row
    Drag the blue handleResize the selected card or image (double-click it for automatic width); a banner's bottom handle sets its height
    Left / Right arrow on the handleStep through the widths
    Alt Up / Down arrow in the outlineMove the focused block up or down
    Enter in the outlineSelect that block
    Delete in the outlineRemove it (undo brings it back)
    Ctrl ZUndo
    Ctrl Shift ZRedo
    Reset button in the top barStart over from the default layout (asks first, undo brings your work back)
    CCopy the markdown
    PSwitch preview light and dark
    ?This list