Documentation

Welcome to the GitFlex documentation. Learn how to create beautiful, dynamic widgets for your GitHub profile README that update automatically.


Quickstart

01

Connect GitHub

Sign in with your GitHub account. We'll automatically import your profile and contribution data to populate the widgets.

02

Choose a Widget

Go to the Dashboard and select "Create Widget". Choose a template like the "Cyberpunk Overview" or "Minimalist Stats".

03

Customize & Save

Use the visual editor to toggle stats, change themes, and adjust colors. Click "Save" when you're happy.

04

Embed Code

Copy the generated Embed Code snippet and paste it into your GitHub profile `README.md` file.


Embedding

GitFlex widgets are dynamic SVG images. This means they work anywhere you can display an image.

# Markdown (GitHub, GitLab, Notion, Obsidian)
<img src="https://gitflex.in/api/view/YOUR_WIDGET_ID" alt="GitFlex Widget" width="420" />

# HTML (Websites, Portfolios)
<img src="https://gitflex.in/api/view/YOUR_WIDGET_ID" alt="GitFlex Widget" width="420" />