ReadMe.io
Maria Eduarda De Souza Marcelino
Dec 7, 2020
0 views0
Comments
ReadMe.io
Code CollaborationWhat 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?
GitHub
GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Over three million people use GitHub to build amazing things together.
Visual Studio Code
Build and debug modern web and cloud applications. Code is free and available on your favorite platform - Linux, Mac OSX, and Windows.
GitLab
GitLab offers git repository management, code reviews, issue tracking, activity feeds and wikis. Enterprises install GitLab on-premise and connect it with LDAP and Active Directory servers for secure authentication and authorization. A single GitLab server can handle more than 25,000 users but it is also possible to create a high availability setup with multiple active servers.
