Product Guide

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started
improved

Prettier API Parameters

Posted by Rafe Goldberg 9 months ago

Hey there—just us, ReadMe, again! We've been hard at work polishing the way we display API parameters in our reference sections. The headliner here is an updated layout that's way more flexible, so your community has a great reading experience, even on smaller screens. (And so this doesn't happen anymore... )

added

Automatically Sync API Specification with GitHub Actions

Posted by Marc Cuva 9 months ago

Yes, we wanted to launch this feature on Halloween just to use this image
improved

New Navigation and Project Dashboard

Posted by Marc Cuva 9 months ago

We’ve made a lot of changes to our dashboard to make things easier to find, and added more information about your project and ReadMe to the Project Dashboard! For more information about these changes, you can read our blog post: https://blog.readme.io/dashboard-fall-cleaning

added

API Endpoints for Changelog + Custom Pages

Posted by Kanad Gupta 9 months ago

We have rolled out API endpoints for Changelog and Custom Pages! Starting today, you can programmatically view and make changes to your data for these two ReadMe modules.

added

Page Metadata

Posted by sean dokko 10 months ago

improved

Two-Factor Authentication

Posted by Kanad Gupta 10 months ago

We've made improvements to our two-factor authentication (2FA) implementation! Now, when you enable 2FA (or view your existing setup) in your profile settings, you have access to backup codes. Once you have 2FA enabled, these one-time use backup codes can be used to log you into ReadMe if you are unable to access 6-digit codes from your authenticator app.

added

Support for OpenAPI 3.0 common path parameters

Posted by Jon Ursenbach 12 months ago

Screenshot of the API Explorer showing demoing usage of common path parameters.
added

Upload API Spec File Directly in ReadMe

Posted by Marc Cuva about a year ago

improved

Improved code highlighting support

Posted by Jon Ursenbach about a year ago

Today we've released some improvements to our code highlighting support across pages and our API Explorer!

improved

Quality of life improvements to our CLI tool

Posted by Jon Ursenbach about a year ago