Introduction to MonoForge

What is MonoForge?#

MonoForge is the premier open-source GitHub Profile README Creation Studio. It empowers developers, software engineers, and open-source contributors to design, customize, and deploy iconic developer profiles.

Unlike traditional generators that output rigid markdown tables or rely on fragile external proxy servers, MonoForge operates on a strictly deterministic, client-first architecture:

• Unified Zustand State: A single store (src/store/useReadmeStore.ts) synchronizes all visual form inputs and raw code editors.
• Pure Markdown Compilation: A pure function (buildMarkdown(config)) translates the profile configuration into GitHub Flavored Markdown (GFM) without side effects.
• 60fps GitHub Camo Safe: Every dynamic asset is engineered with pure CSS @keyframes that pass GitHub Camo CDN sanitization with zero runtime tracking or external scripts.
• Confirmation-Gated Operations: Automated resume extractions and direct GitHub repository writes are strictly confirmation-gated.

Core Philosophy & Architecture#

MonoForge is built on four core tenets:

1. Zero Tracking & External Dependencies: No third-party data harvesters. All telemetry generation is either executed locally in the browser or delivered via authenticated, deterministic APIs.
2. Dual-Mode Parity (Visual Studio & Developer IDE): Switch freely between a guided visual block editor and a split-screen Monaco code editor without losing state.
3. Camo CDN Compliance: GitHub proxies all images through its Camo cache (camo.githubusercontent.com), which aggressively strips <script>, <foreignObject>, and external stylesheets. MonoForge vectors are authored specifically to survive Camo sanitization at 60fps.
4. Deterministic Versioning: Profile configurations conform to a strict Zod schema, allowing profiles to be exported as JSON, version-controlled in Git, and restored anytime.

Key Capabilities#

• Visual Studio Mode: Drag-and-drop block builder, live form controls for avatars, social banners, tech badges, and pinned repositories.
• Developer IDE (Monaco Split Mode): Split Monaco code editor with live syntax highlighting, keyboard shortcuts (Ctrl+S, Ctrl+K), and an AST-safe schema validator.
• 47+ Telemetry Engines: ISO contribution calendars, 3D commit cities, WakaTime programming stats, habit radars, and LeetCode cards.
• SVG Animator Studio: Vector animation engine featuring Cyber Bot, Pixel Dev at dual-monitor desk, Ninja Coder, and matrix rain backgrounds.
• 1-Click GitHub Sync: Authenticated OAuth integration with live remote README diffing before pushing changes directly to your username/username repository.

The Open-Source Commitment#

MonoForge is 100% free and open-source under the MIT License. It requires no paid subscriptions, no mandatory user accounts, and zero proprietary cloud dependencies.