Skip to content

Repository files navigation

Readmify Logo

readmify

Beautiful & Intuitive GitHub Profile README Generator

No sign-up. Live interactive editing. Beautiful template presets. No login required.


Next.jsReactVanilla CSSGSAP
Hugeicons ReactReact MarkdownLicense


Readmify Mockup

WebsiteSource Code


Project Status

Active DevelopmentVersion 0.1.0

Under Development -- Readmify is a modern, web-based profile README generator that replaces generic markdown editors with an intuitive, real-time interactive playground. Built with Next.js 16 and GSAP animations, it helps developers build, customize, and preview stunning GitHub profiles using curated template styles.


Overview

Readmify unifies profile sections, tech stacks, statistics widgets, and developer themes into a single cohesive web application.

Key Features

  • Interactive Template Gallery -- Browse 9 professional layout templates ranging from minimal and recruiter-focused to highly animated, retro terminal, or dragon-themed profiles.
  • Live Markdown Preview -- Side-by-side editing pane and rendered output view that updates in real-time as you type, powered by React Markdown.
  • Curated Tech Stack Selector -- Search, filter, and choose from hundreds of technology badges powered by Simple Icons, complete with automatic color matching.
  • Custom Profile Sections -- Easily configure headers, contact information, statistics widgets, contribution graphs, and developer quotes.
  • Interactive Micro-Interactions -- Smooth entrance animations and page transitions powered by GreenSock (GSAP).
  • Zero Configuration / Zero Cost -- 100% free, requiring no user accounts, database setups, or GitHub OAuth sign-in.

Tech Stack


LayerTechnologyPurpose
FrameworkNext.js 16 (App Router)App framework, SSR, and clean routing
FrontendReact 19UI components and interactive forms
AnimationsGSAP (GreenSock) & @gsap/reactHigh-performance page transitions and micro-interactions
IconsHugeicons ReactSleek, modern stroke icon package
StylingVanilla CSSResponsive layouts and design system variables
Markdown ParserReact Markdown, rehype-raw, remark-gfmAccurate rendering of preview markdown and layouts
Icons CDNSimple IconsDynamic generation of technology badges

Features

Completed

  • 9 pre-built profile templates (Standard, Minimal, Recruiter, Open Source, Fun, Professional, Retro, Dragon, and icodecedd custom style)
  • Interactive live markdown editor with split-pane view
  • Tech stack selector with category filtering and search
  • Dynamic badges preview with Simple Icons
  • GitHub Statistics and Language Cards integration
  • Contribution Activity Graph integration
  • Developer Quotes card generator
  • One-click copy/download of generated markdown
  • GSAP reveal animations for UI landing page
  • Multi-theme support (Dark/Light modes)

In Progress

  • Custom template editor / builder
  • Integrated README deployment via GitHub API (optional login)
  • Local storage persistence for user profile progress
  • PDF export / Resume builder option
  • Extra custom badges creator

Star History

Star History Chart

Contributing

We welcome contributions! Feel free to open issues or submit pull requests to help improve Readmify.


About

A modern, interactive, and zero-config GitHub Profile README generator with live Markdown previews and customizable templates.

Topics

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages