ReadMe.io
Maria Eduarda De Souza Marcelino
Dec 7, 2020
0 views0
CommentsWhat is ReadMe.io?
It is an easy-to-use tool to help you build out documentation! Each documentation site that you publish is a project where there is space for documentation, interactive API reference guides, a changelog, and much more.
ReadMe.io is a tool in the Code Collaboration category of a tech stack.
Key Features
Collaboration - Crowdsource your docs! Users can keep docs current by suggesting changes.API Explorer - Let users play with your API right inside the documentation.GitHub Sync - Keep auto-generated reference docs synced with your actual code.Editor - Markdown-based drag-and-drop editor makes documentation almost fun.Theme Builder - Easily create a beautiful dev community that matches your brand.Support - Let users ask questions and request features in the support forums.Versioning - Maintaining old or testing beta versions of your docs is a breeze!Application Keys - Your users can view their application keys embedded right in the docs.
ReadMe.io Pros & Cons
Pros of ReadMe.io
- ✓Great UI
- ✓Easy
- ✓Customizable
- ✓Cute mascot
- ✓Looks great and is fun to use
- ✓It's friggin awesome
- ✓Make sample API calls inside the docs
Cons of ReadMe.io
- ✗Support is awful
- ✗No backup and restore capability
- ✗Document structure is severely restricted
- ✗Full of bugs
- ✗Important parts of the CSS are locked
- ✗No notifications of edits by other users
- ✗All admins have full editing rights
- ✗Does not support pre-request scripts
- ✗Navigation in user-facing copy is spotty
- ✗Random pages display content of other pages instead
ReadMe.io Alternatives & Comparisons
What are some alternatives to ReadMe.io?
Postman
It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
Swagger UI
Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API
jsdoc
JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you.
Docusaurus
Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
