Welcome to ReadMe Refactored

We've redesigned ReadMe to make documenting your APIs more powerful, collaborative, and enjoyable than ever before. Our refactored platform introduces three game-changing features that transform how you create and maintain documentation.

What's New in ReadMe Refactored

👁️ A Fresh, Elegantly Unified Admin and Editing Experience

Our completely redesigned interface brings documentation creation right to your docs site:

Edit content directly where your users see it
Preview changes instantly in real-time
Access all tools and settings from one unified interface
Manage versions, appearance, and more with ease
Create content seamlessly with our enhanced WYSIWYG editor

Explore the new Editing UI →

⚡ Brand New Components Powered by MDX

Supercharge your documentation with MDX - combining the simplicity of Markdown with the power of JSX:

Use our new pre-built components including tabs, accordions, and cards
Create custom, reusable content blocks
Add interactive elements
Mix Markdown's simplicity with JSX's flexibility

Discover MDX capabilities →

🔄 Bi-Directional Git Sync: Write Docs Where You Want

Keep your documentation and code in perfect harmony with our new bi-directional Git synchronization:

Edit docs seamlessly in ReadMe's interface or your Git repository
Automatically sync changes between platforms
Maintain documentation alongside your code
Leverage existing Git workflows for docs
Collaborate effectively with your entire team

Learn about Git sync →

Getting Started with ReadMe Refactored

Experience the New Interface: Log in to see our unified admin and editing experience.
Try Out MDX Components: Enhance your docs with our new interactive components.
Set Up Git Sync: Connect your repository to enable seamless documentation workflows.

Ready to experience the future of API documentation? Get started with the new Editing UI →