Create your GitHub profile README with a visual editor.
Introduce yourself, share your tools and show what you build. Choose your sections, preview the result as you edit and bring your README.md to GitHub. Save the complete project as JSON to keep editing another day, even on another device.
No sign-in required to build your profile · English and Español interface · Original code licensed under MIT
How it works · Save and continue later · Run locally · Documentation · Contribute
Current editor screenshot with fictional data. Open the example project with Import project (.json) to explore it.
A short profile can tell a story. Every section is optional: start with a few words, some tools or a link, whether or not you have projects or public activity to share.
| What you want to share | What the editor offers |
|---|---|
| Who you are | A centered intro with writing examples, an optional country line, and italic or monospace title styles. |
| What you build with | A searchable technology catalog with icons, editable categories and custom names. |
| What you do | Projects and contributions with editable order, up to ten links per contribution, and public images. |
| Your own content | Repeatable sections with text, lists, links, headings, quotes, dividers, public images, filtered HTML and syntax-highlighted code. |
| Where to find you | Social profiles, a portfolio, websites and email. |
| Public activity, if you choose it | Ten optional card types with themes, colors and a one- or two-card row layout; they require the configuration described below. |
Reorder sections by dragging, using the keyboard or pressing the arrow buttons. Hide a section while keeping its content. On desktop, editing and preview appear side by side; on smaller screens, switch between them. Light and dark themes are available.
Contributions stay manual and editable. Add repository URLs as ordinary links and include any context in the contribution description.
- Choose what to share. Open the editor and add the sections that work for you. Fill them in at your own pace.
- Edit and preview. Write, choose technologies and arrange your content. Preview, copy and download all use the same generated Markdown.
- Bring it to GitHub. Use Copy README or Download README, then place the file at the root of a public repository named exactly like your GitHub username. Follow GitHub's official profile README guide to publish it.
The app prepares the file; you decide when to publish it. GitHub applies its own styles and filters, so the published result may look different from the preview.
Keep editing without starting over. Your draft is saved in your browser, and you can download a complete copy to continue later or on another device.
| File | What it is for |
|---|---|
README.md |
Publishing your introduction on GitHub. |
github-profile.project.json |
Reopening your profile in this generator to keep editing its fields, sections and settings. |
- Choose Export project (.json) below the editor heading to download your work.
- When you return, choose Import project (.json) beside it, then select that
.jsonfile in the dialog. - Review the summary and confirm replacement of the open profile. The app first tries to save a recovery copy of your previous profile.
Project files stay on your device. The dialog explains the supported JSON format and keeps the current profile unchanged until you confirm.
On mobile, the same buttons read Export JSON and Import JSON. Import accepts only JSON files with this generator’s project structure; generic JSON and GitHub profile or API exports are not compatible.
The project keeps your text, order, categories, formatting and hidden content. You can also save unfinished work, even when the README still needs corrections. Opening a project replaces the whole profile after confirmation; it does not merge two projects. Local files up to 4 MiB are processed on your device.
Want to try it first? Download the example project and import it with Import project (.json). It uses fictional data with sample destinations on example.com and github.com/example.
Browser drafts do not sync across devices and can be lost if you clear browser data. Keep the JSON file to continue editing. See the editor guide for local backups and recovery.
Use Import README to paste Markdown or open a .md file. The editor analyzes it and proposes custom sections that you can review and exclude before confirming.
The review is text-only: images remain unloaded, and nothing replaces your profile until you confirm.
The conversion reports formatting changes and content that needs attention; it does not automatically reconstruct the original fields of a JSON project. Before replacing the profile, the app tries to save both the previous profile and the original Markdown. Images and cards remain inactive during review.
Read the import and recovery guide for its limits and the options available if storage fails.
You need Node.js 24.21.0 and pnpm 11.25.0. Versions are pinned in .nvmrc and package.json.
git clone https://github.com/juanNH/ReadmeGenerator.git
cd ReadmeGenerator
pnpm install --frozen-lockfile
pnpm devOpen the editor in English or Español. Building a profile manually requires no environment variables or GitHub account. The app defaults to English and lets you switch languages; your own writing stays in the language you entered.
To serve a production build:
pnpm build
pnpm startThe development guide covers commands, environment setup and the scope of verification.
Describe your contributions manually without querying an account. If the server operator configures the integration, Search data fetches public GitHub data so you can choose which cards to show. All cards start disabled. Searching requires an explicit action, and available data is reused temporarily to avoid repeated requests.
Cards include a calendar, summary, languages, overview and monthly activity, plus five families adapted from GitHub Stats Extended: statistics, languages, repositories, Gists and WakaTime. Charts are rendered by this app with configurable themes and appearance. WakaTime uses a separate username with public statistics.
The odd final card gets its own row. These examples use local samples and do not query account data.
| Server configuration | When it is needed |
|---|---|
GITHUB_TOKEN |
To query GitHub: a dedicated classic PAT with only public_repo, validated by the server and kept out of the browser. |
APP_URL |
To export cards: the public HTTPS origin of the instance hosting their SVGs. A localhost server cannot make them available on GitHub. |
Without a configured public origin, you can review cards locally; README copy and download remain disabled while cards are selected. Deselect them to export your manually entered content. Saving the JSON project remains available.
On Vercel Production, an empty APP_URL uses the project's stable production domain from Vercel's system environment variables. Preview and local instances still need an explicit APP_URL to export cards. The card URLs must be publicly accessible without authentication. See the deployment guide.
Configuration and limits are documented in .env.example, the GitHub API and hosting guide, and the supported card matrix. Public activity does not determine a person's ability, and the optional rank does not measure it either.
Your profile is edited and saved in the browser. Project files and imported Markdown are analyzed locally; drafts are not synced remotely. If storage fails, the editor explains that your work remains only in memory and offers the relevant recovery actions.
Public images load from their original servers. Optional searches contact GitHub or WakaTime through the app's server. Icons use local catalogs in the editor and pinned source references in exported READMEs. The generator does not upload your images or publish to your GitHub account. It includes no AI assistance.
The project uses Next.js App Router, React, TypeScript, Tailwind CSS and next-intl. The profile model and Markdown generator live in a core independent of the interface, network and storage.
Run pnpm check and pnpm build to review a change; browser checks use Playwright. See CONTRIBUTING.md for setup and checks appropriate to each change, and the branching guide for branch names and pull-request targets. The internal /design-system catalog is available only in development.
Found a bug or have a suggestion? Open an issue with the expected behavior and, for a bug, the steps to reproduce it. Keep credentials and private data out of reports.
The guides below cover the editor, product, development, hosting, and architecture.
Deploy with a PAT and without sign-in: Vercel Hobby, main/dev, and card checks.
| To… | Read |
|---|---|
| Use the editor, save projects and import Markdown | Editor guide |
| Understand the product and its limits | Product |
| Install, configure and verify the app | Development |
| Configure queries and publish cards | GitHub API and hosting |
| Understand the architecture and data format | Architecture · Profile model |
| Explore the other guides and decisions | Documentation index |
| Review the release history | Changelog |
Original code is licensed under MIT, with Copyright (c) 2026 Juan Nicolas Herrera. Third-party materials retain their own licenses and attribution; see THIRD_PARTY_NOTICES.md and the open-source guide.
The generator's license does not change the rights to the content each person adds to their README.