Customer StoriesReadMe Blog
Changelog
Start typing to search…
Back to All

Build and Use Custom Components With MDX

March 14th, 2025

Projects using ReadMe Refactored can now build their own custom components with MDX and easily style them with Tailwind. These components can be used anywhere in the documentation and can be used for all kinds of interactive widgets. We have a GitHub repository with example components that you can use in your docs or as a start for your own. We’re super excited to see what you build! 🧩 Building Custom MDX Components

Refactored Some improvements are only available once your project has been upgraded.

New Features & Improvements

  • Versions: Added a new version creation flow to the Refactored interface Refactored
  • API: Added an API endpoint for projects on Refactored to delete a synced OpenAPI file Refactored
  • GitHub Sync: Improved UX for initially syncing a repo when setting up GitHub Sync
  • Accessibility: Added aria-labels to the sidebar and navigation

🐛 Bugs Eaten (by Owlbert)

  • API Reference: Fixed issues with data not loading correctly when navigatign around the reference section Refactored
  • API Reference: Fixed an issue where code samples using our api module weren’t being generated correctly Refactored
  • API Reference: Fixed an issue preventing Windows users from being able to upload YAML OpenAPI Specs Refactored
  • Changelog: Fixed an issue where saving changelog posts sometimes returned an error message even for successful saves Refactored
  • Changelog: Fixed spacing for the author byline Refactored
  • Versions: Better error messages when attempting to create a version with an invalid name Refactored
  • Custom Footer: Fixed an issue updating the custom footer Refactored
  • Documentation: Fixed an issue where the page would crash when navigating between sections containing specific types of content Refactored
  • Editor: Fixed an issue with copying content with newlines in tables cells
  • Enterprise: Fixed styling issues on the Enterprise list of projects page
  • Custom Pages: Fixed code blocks on custom pages not updating to dark mode properly Refactored
  • API Designer: Fixed an issue where pages were marked as having unsaved changes erroneously
  • Recipes: Fixed an issue where on page load the code snippet would overlap with the line numbers
  • Sitemap: Fixed an issue where the sitemap sometimes has stale content Refactored