Let's start with the basics
Your username powers the live widgets. The header is the big line at the top; the headlines are the small lines beneath it.
About you
A short intro, plus optional lines. Drag the ⋮⋮ handle to reorder how they appear.
Tech stack
Pick what you work with. Each selection becomes a colored badge in your README.
Connect
Add the links you want people to find. Enter just a handle — we'll build the full URL. Drag ⋮⋮ to reorder.
Dynamic add-ons
Live widgets that auto-update on your real profile. They render from your GitHub username.
Your README is ready
Grab the markdown, or start a fresh profile. Publishing it takes about 30 seconds.
-
Create a new public repository named exactly the same as
your GitHub username:
your-github-username. -
Add the
README.mdfile you just downloaded to the root of the repository. -
Commit the changes, then visit
github.com/your-github-username. Your README will appear on your GitHub profile.
Example:
If your GitHub username is your-github-username, your special
repository must also be named your-github-username.
Your package contains the files required for the dynamic features you enabled. Copy the package contents into the root of your GitHub profile repository.
- Create or open your public profile repository named exactly the same as your GitHub username.
-
Copy the downloaded package contents into the repository. Merge the
.githubfolder if you already have workflows. -
If you enabled the dot-matrix portrait, keep
assets/profile-studio/portrait.svgin place. -
If you enabled Contribution Activity or Contribution Snake, allow GitHub Actions to write to the
repository and run Update Profile Studio Contribution Activity once.
The generated activity graph and snake assets are published to the
outputbranch. - If you enabled DEV.to automation, keep its generated workflow and configuration alongside the other Profile Studio files.
Profile Studio only updates the dynamic assets/features you enabled. Your main README content remains yours.