Menu
User-friendly Interface
ReadMe offers a clean, intuitive interface that makes it easy for users to create and manage documentation without requiring extensive technical skills.
Interactive API Documentation
The platform provides interactive API documentation, allowing users to try out API calls directly within the documentation, which enhances user understanding and engagement.
Customizability
ReadMe allows a high level of customization, enabling users to tailor the look and feel of their documentation to match their brand identity.
Analytics
The service offers built-in analytics, providing insights into how users interact with the documentation, which can help in improving user experience and understanding common issues.
Version Control
ReadMe supports version control, making it easy to manage and maintain documentation for different versions of an API or product.
Collaboration Tools
It includes collaboration tools that facilitate teamwork by allowing multiple users to work on documentation simultaneously.
Markdown Support
The platform supports Markdown, making it easy for users to format their documentation efficiently.
I came across readme.io some days back, and It’s like that fresh outfit you wear to high-end parties—the one with crisp lines, dark colors, and intricate designs that make you stand out. Their documentation platform is sleek, modern, and highly customizable to fit your brand’s drip. It’s like having a tailor sew a 007 suit (James Bond) to your specs.
– Source: dev.to
/
4 months ago
Readme.com — Beautiful documentation made easy, free for Open Source.
– Source: dev.to
/
8 months ago
I believe they are using https://readme.com/.
– Source: Hacker News
/
about 1 year ago
Seems more expensive that readme.com!!! But looks really good!
Source:
over 1 year ago
The main pros I like about readme.com – you can manage it with Code As Docs paradigm – you just sync your OpenAPI specs and markdown pages from your repository to their site.
Source:
over 1 year ago
Readme: Readme is a popular documentation platform that can be used for API documentation. It provides a user-friendly interface for creating and publishing API documentation, and supports both OpenAPI and Swagger.
– Source: dev.to
/
over 1 year ago
I’m looking for some cool tools to use for the design aspect. Similar to readme.com.
Source:
over 1 year ago
Readme.com — Beautiful documentation made easy, free for Open Source.
– Source: dev.to
/
almost 2 years ago
Https://github.com/rswag/rswag – helps generate Swagger documentation (you can upload it to an external service, like readme.com or serve from your Rails app).
Source:
almost 2 years ago
YNAB must use readme.com as they had a major outage today that affected all businesses that use them with the DNS error 1016. We were also affected at my job.
Source:
about 2 years ago
u/IntroThrive why has readme.com been met with resistance?
Source:
over 2 years ago
Ha, publishing pipeline is basically drafting in Google Docs and then transferring to and publishing in WordPress. I’ve been pushing for an actual docs application (I’ve used https://readme.com/ in my previous role) but it’s been met with resistance.
Source:
over 2 years ago
I don’t know about AsyncAPI but with https://readme.com/ you can upload an OpenAPI file and it generates a nice documentation.
– Source: Hacker News
/
over 2 years ago
For a few out-of-the-box options, readme.com has a good one (with monthly fee), but I just swagger (i.e. https://api.streamduo.com/swagger-ui.html) which has some pretty easy integration depending on what you wrote your APIs in. I use springboot, and it’s super easy to generate that API page.
Source:
over 2 years ago
To get more 😉 Swagger-like plan is free. For 90$ you get tool more like redoc.ly Basic or readme.com Startup plan.
Source:
almost 3 years ago
I have heard really good things about about https://readme.com/.
– Source: Hacker News
/
about 3 years ago
Readme.com — Beautiful documentation made easy, free for Open Source.
– Source: dev.to
/
about 3 years ago
I would recommend looking into Swagger. You specify your entire API (models, endpoints, requests, responses, and descriptions too) and there are additional tools that understand Swagger syntax. For instance, https://readme.com lets you upload a Swagger specification and generate documentation from it. There are also tools out there to generate boilerplate code for your application as well, such as models and HTTP…
Source:
over 3 years ago
Posting the link here so it’s clickable: https://readme.com/recipes.
– Source: Hacker News
/
over 3 years ago
Heya HN! I launched ReadMe here a few years ago as a Show HN (and even got the domain by randomly happening across someone giving it away here: https://news.ycombinator.com/item?id=6397526), so I figured this was a good place to post our newest feature, ReadMe Recipes. Here’s the link: https://readme.com/recipes Most API documentation focuses on Reference Guides, which have the information you need about an API……
– Source: Hacker News
/
over 3 years ago
I am trying to solve a couple of problems in the API doc SAAS domain. If any one of you ever had a chance to use any existing product like https://readme.com/ to document your APIs, what did you feel was missing and what would you like to see in the upcoming product?
Source:
over 3 years ago
