readme-studio

Professional GitHub profile README generator with live preview — banners, skills, stats, badges and more

Language
JavaScript
Stars
0
Last updated

From the README

A professional GitHub profile README generator that runs entirely in the browser — no build step, no backend, no sign-up. Design your profile with a live preview and export polished markdown in one click.

Features

  • Live preview rendered GitHub-style inside a browser frame, plus a raw Markdown view
  • Banner — animated capsule-render waves (9 shapes, gradient / solid colors, adjustable height)
  • Typing animation with custom lines, color and size
  • About Me builder — the classic emoji bullet list (working on, learning, ask me about, fun fact…)
  • 110+ skills across 9 categories, as colorful Skill Icons or Shields.io badges, grouped or flat
  • 24 social platforms with badge style options (for-the-badge, flat, social…)
  • GitHub stats — stats card, contribution streak, top languages (5 layouts), trophies, activity graph, with 14 shared themes
  • Projects — pinned repo cards and a custom project list
  • Add-ons — 🐍 contribution snake (with one-click workflow copy), dev quotes, dev jokes, GIFs
  • Support links — Buy Me a Coffee, Ko-fi, PayPal
  • Layout manager — reorder and toggle every section
  • 3 templates — Clean Start, The Developer, Full Power
  • Autosave to your browser, dark/light theme, copy or download README.md

Host it on GitHub Pages

  1. Create a new GitHub repository (e.g. readme-studio) and push these files to it:
    git init
    git add .
    git commit -m "README Studio"
    git branch -M main
    git remote add origin https://github.com/YOUR-USERNAME/readme-studio.git
    git push -u origin main
    
  2. In the repository, open Settings → Pages.
  3. Under Build and deployment, set Source to Deploy from a branch, pick the main branch and the / (root) folder, then save.
  4. Your generator goes live at https://YOUR-USERNAME.github.io/readme-studio/ within a minute or two.

Run locally

Just open index.html in a browser. (An internet connection is needed for the markdown renderer, fonts and the live stat/badge images.)

Using your generated README

  1. Create a public repository named exactly your username — e.g. octocat/octocat.
  2. Add the markdown from Copy Markdown or Download README.md as its README.md.
  3. If you enabled the snake animation, also add the workflow from the Add-ons tab as .github/workflows/snake.yml and run it once from the Actions tab.

Credits

Widgets rendered by these great community services: capsule-render, readme-typing-svg, skillicons.dev, shields.io, github-readme-stats, streak-stats, github-profile-trophy, activity-graph, komarev profile views, snk.