ReadMe Documentation Platform
Product · SaaS / cloud software · Engineering & development by ReadMe
The full documentation stack for building developer hubs that drive API adoption.
ReadMe is a SaaS documentation platform designed for businesses to build interactive developer hubs and API references. It transforms OpenAPI specifications into explorable documentation where developers can make real-time API calls using a "Try It!" feature. The platform supports a full documentation stack including Markdown guides, changelogs, and community forums, all manageable through a WYSIWYG editor or Git-based workflows. ReadMe also provides developer analytics and usage metrics to help teams monitor API adoption and troubleshoot issues. It is used by companies like NVIDIA, Amazon, an
- Price
- From 0 USD
- Languages
- English
- Supported OpenAPI Versions
- 3.0, 3.1, Swagger 2.0
- Code Snippet Languages
- 60+ languages
- Custom Widgets
- 40+ widgets
- Default Log History
- 24 hours
- Extended Log History Add-on
- 1 year
Overview
ReadMe is a SaaS documentation platform designed for businesses to build interactive developer hubs and API references. It transforms OpenAPI specifications into explorable documentation where developers can make real-time API calls using a "Try It!" feature. The platform supports a full documentation stack including Markdown guides, changelogs, and community forums, all manageable through a WYSIWYG editor or Git-based workflows. ReadMe also provides developer analytics and usage metrics to help teams monitor API adoption and troubleshoot issues. It is used by companies like NVIDIA, Amazon, and PagerDuty to turn static docs into functional products.
API Reference & Interaction
- OpenAPI Support: Automatically generates a reference from OpenAPI 3.0, 3.1, or Swagger 2.0 specifications.
- Interactive Try It!: Allows developers to make test calls and see real responses directly from the documentation without writing code.
- API Designer: Provides an intuitive interface to document endpoints, parameters, and response objects without writing YAML or JSON.
- Terminal Widget: Includes a terminal widget for displaying and running example code snippets.
- Multi-language Code Samples: Supports syntax-highlighted code snippets for over 60 programming languages.
Content Management & Authoring
- MDX Editor: Features a WYSIWYG editor backed by Markdown and MDX for creating guides and tutorials.
- Custom Widgets: Includes over 40 widgets such as accordions, callouts, tabs, and Mermaid diagrams to customize pages.
- Reusable Content: Allows teams to create content blocks that can be used across multiple pages and projects.
- Git Integration: Enables bi-directional synchronization with GitHub, GitHub Enterprise Server, GitLab, and Bitbucket.
- Landing Pages: Provides a customizable landing page to introduce products and build developer hubs.
Workflow & Analytics
- Versioning & Branching: Supports multiple versions and feature branches to manage documentation across product releases.
- Multiplayer Editing: Allows multiple team members to edit documentation simultaneously.
- Developer Dashboard: Provides in-depth developer profiles and analytics on API usage and performance.
- Community Forums: Includes a built-in discussion forum for community-driven support.
- Doc Analytics: Tracks documentation metrics including page views and search queries.
Specifications
- Supported OpenAPI Versions
- 3.0, 3.1, Swagger 2.0
- Code Snippet Languages
- 60+ languages
- Custom Widgets
- 40+ widgets
- Default Log History
- 24 hours
- Extended Log History Add-on
- 1 year
Plans
- Starter: 0 month
- Core Documentation: Includes an interactive API reference and Markdown editor for one project.
- Git Sync: Enables bi-directional sync with Git repositories.
- MCP Server: Provides a hosted MCP server for AI agent discovery.
- Basic Analytics: Includes 24 hours of API request history and detailed logs.
- Pro: 250 month
- Multiplayer Editing: Enables multiple team members to edit documentation at the same time.
- Branching & Reviews: Supports unlimited published versions and feature branches for reviews.
- Advanced Customization Spaces: Allows for custom CSS and HTML to match brand identity.
- Community Features: Includes a landing page, changelog, recipes, and community forums.
- Enterprise
- Multi-project Management: Supports a custom number of projects with aggregated documentation metrics.
- White-labeling: Removes all ReadMe branding from the developer hub.
- Global Content Library: Provides a global reusable content library for use across all projects.
- Includes managed onboarding, implementation, and content migration services.
Added by AntSpace from public sources (readme.com).
Related
- Faster collaboration and a unified experience: Why Akamai switched from a custom solution to ReadMe
- Minimal time, maximum personalization: How Atelio by FIS leveraged ReadMe's Professional Services
- OneTrust: Scalable, secure solution for API docs
- Socure: Driving API engagement and lowering support costs