// docs

Documentation

Everything you need to build a GitHub profile README that stands out.

Quick Start

GitProfile generates a README.md for your GitHub profile in under 2 minutes. Here's the fastest path:

  1. 01

    Sign up or sign in with GitHub OAuth.

  2. 02

    Open the Builder — your GitHub bio auto-fills.

  3. 03

    Pick a template, choose an accent color.

  4. 04

    Click Export → Copy Markdown.

  5. 05

    Create a GitHub repo named exactly your-username/your-username and paste the markdown into README.md.

Open BuilderGitHub Guide

Using the Builder

The builder has four tabs:

Profile

Name, bio, location, social links. Enter your GitHub username to auto-fill everything.

Stack

Multi-select from 40+ technologies. Displayed as color-coded badges on your profile.

Style

Accent color, banner style, avatar emoji. Pro users get the full color picker.

Sections

Toggle each card section on/off: Stats, Streak, Heatmap, Languages, Repos, Socials.

The preview on the right updates live as you type — no save needed to see changes.

Templates

Each template is a complete visual preset — background color, section heading style, font choice, stat layout, and banner height are all defined per template.

TemplateTierStyle
Classic DarkFreeDark, minimal, gradient dividers
Minimal LightFreeLight background, clean typography
HackerFreeTerminal green-on-black, bracket headings
Gradient ProProBold gradient banner, big stat numbers
Tokyo NightProVS Code Tokyo Night palette
DraculaProDracula theme colors
NordProArctic blues, side-by-side header
Developer ProProComplete layout, all sections
Creative CardProAsymmetric, high contrast
Startup FounderProProject-focused, gold accents

GitHub Stats

On the Pro plan, enter your GitHub username in the Profile tab and toggle Auto-fetch from GitHub. GitProfile fetches:

  • Total commits, stars, forks, PRs, issues
  • Current streak and longest streak
  • Top languages by bytes of code
  • 52-week contribution heatmap
  • Top repositories (by stars)

⚡ Pro tip: GitHub's API has a 60 req/hr rate limit for unauthenticated requests. Set GITHUB_TOKEN in your .env to raise this to 5000 req/hr.

Export & Embed

Click the Export button in the builder toolbar to open the export panel.

Markdown

Pro

Copies full README.md with shields.io badge URLs. Paste directly into GitHub.

Embed iframe

Free

HTML iframe code. Paste on any website to show a live-updating profile card.

Share URL

Free

Direct link to your public /p/[slug] profile page.

Free tier embeds include a small "Made with GitProfile" footer. Pro and Team embeds are completely clean.

Markdown Reference

GitProfile generates standard GitHub-flavored markdown. Key patterns used:

markdown
<!-- Centered header with HTML (GitHub supports this) -->
<div align="center">
  <h1>Hi, I'm Alex 🚀</h1>
  <p>Full-stack developer · Open source contributor</p>
</div>

<!-- GitHub Stats badge (via github-readme-stats) -->
![Stats](https://github-readme-stats.vercel.app/api?username=alexdev&theme=dark)

<!-- Streak badge (via streak-stats) -->
![Streak](https://streak-stats.demolab.com?user=alexdev&theme=dark)

<!-- shields.io badge for tech stack -->
![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)

All badge URLs are generated automatically by the markdown exporter. You don't need to write them manually.

FAQ

My GitHub stats aren't showing up correctly.

GitHub's API can take up to 24 hours to reflect new contributions. Contributions in private repos won't appear unless you've enabled that in your GitHub settings under 'Private contributions'.

Can I use GitProfile without a GitHub account?

Yes. Sign up with email + password and enter your stats manually in the Profile tab. The auto-fetch feature requires GitHub OAuth.

How do I create my profile README on GitHub?

Create a new public repository with the same name as your GitHub username (e.g. github.com/alexdev/alexdev). Add a README.md file and paste your exported markdown.

The embed iframe shows a watermark. How do I remove it?

Upgrade to Pro. Free tier embeds include a small 'Made with GitProfile' footer. Pro and Team embeds are completely clean.

Can I use GitProfile for multiple profiles?

Free tier allows 1 saved profile. Pro allows unlimited profiles — useful if you maintain separate work and personal profiles.