Alternatives to ReadMe.io logo

Alternatives to ReadMe.io

Swagger UI, Confluence, Gitbook, Apiary, and Postman are the most popular alternatives and competitors to ReadMe.io.
95
250
+ 1
70

What is ReadMe.io and what are its top alternatives?

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 Documentation as a Service & Tools category of a tech stack.

Top Alternatives to ReadMe.io

  • Swagger UI

    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 ...

  • Confluence

    Confluence

    Capture the knowledge that's too often lost in email inboxes and shared network drives in Confluence instead – where it's easy to find, use, and update. ...

  • Gitbook

    Gitbook

    It is a modern documentation platform where teams can document everything from products, to APIs and internal knowledge-bases. It is a place to think and track ideas for you & your team. ...

  • Apiary

    Apiary

    It takes more than a simple HTML page to thrill your API users. The right tools take weeks of development. Weeks that apiary.io saves. ...

  • Postman

    Postman

    It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide. ...

  • jsdoc

    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

    Docusaurus is a project for easily building, deploying, and maintaining open source project websites. ...

  • Read the Docs

    Read the Docs

    It hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. ...

ReadMe.io alternatives & related posts

Swagger UI logo

Swagger UI

1.5K
1.3K
200
A Collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation
1.5K
1.3K
+ 1
200
PROS OF SWAGGER UI
  • 46
    Open Source
  • 33
    Can execute api calls from the documentation
  • 28
    Free to use
  • 19
    Customizable
  • 14
    Easy to implement in .Net
  • 13
    Mature, clean spec
  • 11
    API Visualization
  • 9
    Coverage
  • 6
    Easy to use
  • 6
    Scaffolding
  • 5
    Vibrant and active community
  • 4
    Elegant
  • 3
    Adopted by tm forum api
  • 2
    Clear for React
  • 1
    Can deploy API to AWS API Gateway and AWS Lambda
CONS OF SWAGGER UI
  • 2
    Need to learn YAML and RAML
  • 1
    You don’t actually get in-line error highlighting
  • 1
    Does not support hypermedia

related Swagger UI posts

Noah Zoschke
Engineering Manager at Segment · | 30 upvotes · 2M views

We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.

Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username, password and workspace_name so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.

Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.

This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.

Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct

Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.

Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.

See more
Simon Reymann
Senior Fullstack Developer at QUANTUSflow Software GmbH · | 24 upvotes · 1.8M views

Our whole Node.js backend stack consists of the following tools:

  • Lerna as a tool for multi package and multi repository management
  • npm as package manager
  • NestJS as Node.js framework
  • TypeScript as programming language
  • ExpressJS as web server
  • Swagger UI for visualizing and interacting with the API’s resources
  • Postman as a tool for API development
  • TypeORM as object relational mapping layer
  • JSON Web Token for access token management

The main reason we have chosen Node.js over PHP is related to the following artifacts:

  • Made for the web and widely in use: Node.js is a software platform for developing server-side network services. Well-known projects that rely on Node.js include the blogging software Ghost, the project management tool Trello and the operating system WebOS. Node.js requires the JavaScript runtime environment V8, which was specially developed by Google for the popular Chrome browser. This guarantees a very resource-saving architecture, which qualifies Node.js especially for the operation of a web server. Ryan Dahl, the developer of Node.js, released the first stable version on May 27, 2009. He developed Node.js out of dissatisfaction with the possibilities that JavaScript offered at the time. The basic functionality of Node.js has been mapped with JavaScript since the first version, which can be expanded with a large number of different modules. The current package managers (npm or Yarn) for Node.js know more than 1,000,000 of these modules.
  • Fast server-side solutions: Node.js adopts the JavaScript "event-loop" to create non-blocking I/O applications that conveniently serve simultaneous events. With the standard available asynchronous processing within JavaScript/TypeScript, highly scalable, server-side solutions can be realized. The efficient use of the CPU and the RAM is maximized and more simultaneous requests can be processed than with conventional multi-thread servers.
  • A language along the entire stack: Widely used frameworks such as React or AngularJS or Vue.js, which we prefer, are written in JavaScript/TypeScript. If Node.js is now used on the server side, you can use all the advantages of a uniform script language throughout the entire application development. The same language in the back- and frontend simplifies the maintenance of the application and also the coordination within the development team.
  • Flexibility: Node.js sets very few strict dependencies, rules and guidelines and thus grants a high degree of flexibility in application development. There are no strict conventions so that the appropriate architecture, design structures, modules and features can be freely selected for the development.
See more
Confluence logo

Confluence

16.5K
11.3K
196
One place to share, find, and collaborate on information
16.5K
11.3K
+ 1
196
PROS OF CONFLUENCE
  • 93
    Wiki search power
  • 61
    WYSIWYG editor
  • 41
    Full featured, works well with embedded docs
  • 1
    Expensive licenses
CONS OF CONFLUENCE
  • 2
    Expensive license

related Confluence posts

David Ritsema
Frontend Architect at Herman Miller · | 11 upvotes · 573.2K views

We knew how we wanted to build our Design System, now it was time to choose the tools to get us there. The essence of Scrum is a small team of people. The team is highly flexible and adaptive. Perfect, so we'll work in 2 week sprints where each sprint can be a mix of new R&D stories, a presentation of decisions made, and showcasing key development milestones.

We are also able to run content stories in parallel, focusing development efforts around key areas of the site that our authors need first. Our stories would exist in a Jira backlog, documentation would be hosted in Confluence , and GitHub would host our codebase. If developers identify technical improvements during the sprint, they can be added as GitHub issues and transferred to Jira if we decide to represent them as stories for the Backlog. For Sprint Retrospectives, @groupmap proved to be a great way to include our remote members of the dev team.

This worked well for our team and allowed us to be flexible in what we wanted to build and how we wanted to build it. As we further defined our Backlog and estimated each story, we could accurately measure the team's capacity (velocity) and confidently estimate a launch date.

See more
Priit Kaasik
Engineering Lead at Katana MRP · | 9 upvotes · 421.3K views

As a new company we could early adopt and bet on #RemoteTeam setup without cultural baggage derailing us. Our building blocks for developing remote working culture are:

  • Hiring people who are self sufficient, self-disciplined and excel at video and written communication to work remotely
  • Set up periodic ceremonies ( #DailyStandup, #Grooming, Release calls and chats etc) to keep the company rhythm / heartbeat going across remote cells
  • Regularly train your leaders to take into account remote working aspects of organizing f2f calls, events, meetups, parties etc. when communicating and organizing workflows
  • And last, but not least - select the right tools to support effective communication and collaboration:
  1. All feeds and conversations come together in Slack
  2. #Agile workflows in Jira
  3. InProductCommunication and #CustomerSupportChat in Intercom
  4. #Notes, #Documentation and #Requirements in Confluence
  5. #SourceCode and ContinuousDelivery in Bitbucket
  6. Persistent video streams between locations, demos, meetings run on appear.in
  7. #Logging and Alerts in Papertrail
See more
Gitbook logo

Gitbook

151
218
1
Document Everything! For you, your users and your team
151
218
+ 1
1
PROS OF GITBOOK
  • 1
    Integrated high-quality editor
CONS OF GITBOOK
  • 1
    Just sync with GitHub

related Gitbook posts

Apiary logo

Apiary

218
263
108
Integrated API documentation, prototyping and testing
218
263
+ 1
108
PROS OF APIARY
  • 28
    Easy to use
  • 19
    Free to use
  • 12
    Traffic inspector
  • 11
    Free
  • 10
    Collaboration
  • 7
    Mock API
  • 4
    Dashboard
  • 3
    Customization
  • 2
    30 Days Trial
  • 2
    Documentation
  • 2
    Access Control
  • 2
    Validate API Documentation
  • 1
    API explorer
  • 1
    Clean syntax
  • 1
    Provisioning
  • 1
    Shared API blueprint templates
  • 1
    Github integration helps with collaboration
  • 1
    Code auto-generation
CONS OF APIARY
    Be the first to leave a con

    related Apiary posts

    Postman logo

    Postman

    56.9K
    45.3K
    1.7K
    Only complete API development environment
    56.9K
    45.3K
    + 1
    1.7K
    PROS OF POSTMAN
    • 481
      Easy to use
    • 366
      Great tool
    • 274
      Makes developing rest api's easy peasy
    • 154
      Easy setup, looks good
    • 142
      The best api workflow out there
    • 53
      History feature
    • 53
      It's the best
    • 43
      Adds real value to my workflow
    • 41
      Great interface that magically predicts your needs
    • 34
      The best in class app
    • 10
      Can save and share script
    • 9
      Fully featured without looking cluttered
    • 7
      Collections
    • 6
      Global/Environment Variables
    • 6
      Shareable Collections
    • 6
      Dead simple and useful. Excellent
    • 6
      Dark theme easy on the eyes
    • 6
      Option to run scrips
    • 5
      Awesome customer support
    • 5
      Great integration with newman
    • 4
      The test script is useful
    • 3
      This has simplified my testing significantly
    • 3
      Easy as pie
    • 3
      Simple
    • 3
      Documentation
    • 3
      Makes testing API's as easy as 1,2,3
    • 3
      Saves responses
    • 2
      API-network
    • 2
      Mocking API calls with predefined response
    • 2
      I'd recommend it to everyone who works with apis
    • 1
      Pre-request Script and Test attributes are invaluable
    • 1
      Postman Runner CI Integration
    • 1
      Now supports GraphQL
    • 1
      Continuous integration using newman
    • 1
      Easy to setup, test and provides test storage
    • 1
      Graph
    • 0
      <a href="http://fixbit.com/">useful tool</a>
    • 0
      Runner
    CONS OF POSTMAN
    • 8
      Stores credentials in HTTP
    • 7
      Poor GraphQL support
    • 6
      Bloated features and UI
    • 5
      Cumbersome to switch authentication tokens
    • 2
      Expensive
    • 1
      Can't prompt for per-request variables

    related Postman posts

    Noah Zoschke
    Engineering Manager at Segment · | 30 upvotes · 2M views

    We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.

    Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username, password and workspace_name so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.

    Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.

    This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.

    Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct

    Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.

    Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.

    See more
    Simon Reymann
    Senior Fullstack Developer at QUANTUSflow Software GmbH · | 24 upvotes · 1.8M views

    Our whole Node.js backend stack consists of the following tools:

    • Lerna as a tool for multi package and multi repository management
    • npm as package manager
    • NestJS as Node.js framework
    • TypeScript as programming language
    • ExpressJS as web server
    • Swagger UI for visualizing and interacting with the API’s resources
    • Postman as a tool for API development
    • TypeORM as object relational mapping layer
    • JSON Web Token for access token management

    The main reason we have chosen Node.js over PHP is related to the following artifacts:

    • Made for the web and widely in use: Node.js is a software platform for developing server-side network services. Well-known projects that rely on Node.js include the blogging software Ghost, the project management tool Trello and the operating system WebOS. Node.js requires the JavaScript runtime environment V8, which was specially developed by Google for the popular Chrome browser. This guarantees a very resource-saving architecture, which qualifies Node.js especially for the operation of a web server. Ryan Dahl, the developer of Node.js, released the first stable version on May 27, 2009. He developed Node.js out of dissatisfaction with the possibilities that JavaScript offered at the time. The basic functionality of Node.js has been mapped with JavaScript since the first version, which can be expanded with a large number of different modules. The current package managers (npm or Yarn) for Node.js know more than 1,000,000 of these modules.
    • Fast server-side solutions: Node.js adopts the JavaScript "event-loop" to create non-blocking I/O applications that conveniently serve simultaneous events. With the standard available asynchronous processing within JavaScript/TypeScript, highly scalable, server-side solutions can be realized. The efficient use of the CPU and the RAM is maximized and more simultaneous requests can be processed than with conventional multi-thread servers.
    • A language along the entire stack: Widely used frameworks such as React or AngularJS or Vue.js, which we prefer, are written in JavaScript/TypeScript. If Node.js is now used on the server side, you can use all the advantages of a uniform script language throughout the entire application development. The same language in the back- and frontend simplifies the maintenance of the application and also the coordination within the development team.
    • Flexibility: Node.js sets very few strict dependencies, rules and guidelines and thus grants a high degree of flexibility in application development. There are no strict conventions so that the appropriate architecture, design structures, modules and features can be freely selected for the development.
    See more
    jsdoc logo

    jsdoc

    101
    125
    5
    An API documentation generator for JavaScript
    101
    125
    + 1
    5
    PROS OF JSDOC
    • 2
      Far less verbose
    • 1
      Simpler type safe than TypeScript
    • 1
      No compiler needed
    • 1
      Does almost everything TS does
    CONS OF JSDOC
      Be the first to leave a con

      related jsdoc posts

      Docusaurus logo

      Docusaurus

      71
      251
      23
      Easy to maintain open source documentation websites
      71
      251
      + 1
      23
      PROS OF DOCUSAURUS
      • 6
        Self Hosted
      • 5
        Open Source
      • 2
        Jamstack
      • 2
        Free to use
      • 2
        MDX
      • 2
        Easy customization
      • 2
        React
      • 1
        I18n
      • 1
        Versioning
      CONS OF DOCUSAURUS
        Be the first to leave a con

        related Docusaurus posts

        Read the Docs logo

        Read the Docs

        60
        212
        22
        Create, host, and browse documentation
        60
        212
        + 1
        22
        PROS OF READ THE DOCS
        • 13
          GitHub integration
        • 7
          Free for public repos
        • 2
          Automated Builds
        CONS OF READ THE DOCS
          Be the first to leave a con

          related Read the Docs posts

          Todd Gardner

          We recently needed to rebuild our documentation site, currently built using Jekyll hosted on GitHub Pages. We wanted to update the content and refresh the style to make it easier to find answers.

          We considered hosted services that could accept our markdown content, like ReadMe.io and Read the Docs, however both seemed expensive for essentially hosting the same platform we already had for free.

          I also looked at the Gatsby Static Site generator to modernize Jekyll. I don't think this is a fit, as our documentation is relatively simple and relies heavily on Markdown. Jekyll excels at Markdown, while Gatsby seemed to struggle with it.

          We chose to stick with the current platform and just refresh our template and style with some add-on JavaScript.

          See more