Alternatives to Read the Docs logo

Alternatives to Read the Docs

Gitbook, Confluence, Sphinx, MkDocs, and GitHub Pages are the most popular alternatives and competitors to Read the Docs.
60
229
+ 1
22

What is Read the Docs and what are its top alternatives?

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.
Read the Docs is a tool in the Documentation as a Service & Tools category of a tech stack.
Read the Docs is an open source tool with 6.8K GitHub stars and 3.5K GitHub forks. Here’s a link to Read the Docs's open source repository on GitHub

Top Alternatives to Read the Docs

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

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

  • Sphinx

    Sphinx

    It lets you either batch index and search data stored in an SQL database, NoSQL storage, or just files quickly and easily — or index and search data on the fly, working with it pretty much as with a database server. ...

  • MkDocs

    MkDocs

    It builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose. There's a stack of good looking themes available. The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes. ...

  • GitHub Pages

    GitHub Pages

    Public webpages hosted directly from your GitHub repository. Just edit, push, and your changes are live. ...

  • Postman

    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

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

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

Read the Docs alternatives & related posts

Gitbook logo

Gitbook

158
240
4
Document Everything! For you, your users and your team
158
240
+ 1
4
PROS OF GITBOOK
  • 2
    Prueba
  • 2
    Integrated high-quality editor
CONS OF GITBOOK
  • 1
    Just sync with GitHub

related Gitbook posts

Confluence logo

Confluence

18.4K
12.8K
196
One place to share, find, and collaborate on information
18.4K
12.8K
+ 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
  • 3
    Expensive license

related Confluence posts

David Ritsema
Frontend Architect at Herman Miller · | 11 upvotes · 594.3K 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 · 442.5K 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
Sphinx logo

Sphinx

268
241
27
Open source full text search server, designed from the ground up with performance, relevance (aka search quality), and...
268
241
+ 1
27
PROS OF SPHINX
  • 15
    Fast
  • 7
    Simple deployment
  • 5
    Open source
  • 0
    Lots of extentions
CONS OF SPHINX
    Be the first to leave a con

    related Sphinx posts

    MkDocs logo

    MkDocs

    65
    97
    2
    A static site generator
    65
    97
    + 1
    2
    PROS OF MKDOCS
    • 2
      Gitlab integration
    CONS OF MKDOCS
      Be the first to leave a con

      related MkDocs posts

      Nikolaj Ivancic

      I want to build a documentation tool - functionally equivalent to MkDocs. The initial choice ought to be VuePress - but I know of at least one respectable developer who started with VuePress and switched to Nuxt.js. A rich set of "themes" is a plus and all documents ought to be in Markdown.

      Any opinions?

      See more
      GitHub Pages logo

      GitHub Pages

      14.2K
      10K
      1.1K
      Public webpages freely hosted and easily published.
      14.2K
      10K
      + 1
      1.1K
      PROS OF GITHUB PAGES
      • 289
        Free
      • 217
        Right out of github
      • 185
        Quick to set up
      • 108
        Instant
      • 107
        Easy to learn
      • 58
        Great way of setting up your project's website
      • 47
        Widely used
      • 41
        Quick and easy
      • 37
        Great documentation
      • 4
        Super easy
      • 3
        Easy setup
      • 2
        Instant and fast Jekyll builds
      • 2
        Great customer support
      • 2
        Great integration
      CONS OF GITHUB PAGES
      • 4
        Not possible to perform HTTP redirects
      • 3
        Supports only Jekyll
      • 3
        Limited Jekyll plugins
      • 1
        Jekyll is bloated

      related GitHub Pages posts

      Simon Reymann
      Senior Fullstack Developer at QUANTUSflow Software GmbH · | 28 upvotes · 3.3M views

      Our whole DevOps stack consists of the following tools:

      • GitHub (incl. GitHub Pages/Markdown for Documentation, GettingStarted and HowTo's) for collaborative review and code management tool
      • Respectively Git as revision control system
      • SourceTree as Git GUI
      • Visual Studio Code as IDE
      • CircleCI for continuous integration (automatize development process)
      • Prettier / TSLint / ESLint as code linter
      • SonarQube as quality gate
      • Docker as container management (incl. Docker Compose for multi-container application management)
      • VirtualBox for operating system simulation tests
      • Kubernetes as cluster management for docker containers
      • Heroku for deploying in test environments
      • nginx as web server (preferably used as facade server in production environment)
      • SSLMate (using OpenSSL) for certificate management
      • Amazon EC2 (incl. Amazon S3) for deploying in stage (production-like) and production environments
      • PostgreSQL as preferred database system
      • Redis as preferred in-memory database/store (great for caching)

      The main reason we have chosen Kubernetes over Docker Swarm is related to the following artifacts:

      • Key features: Easy and flexible installation, Clear dashboard, Great scaling operations, Monitoring is an integral part, Great load balancing concepts, Monitors the condition and ensures compensation in the event of failure.
      • Applications: An application can be deployed using a combination of pods, deployments, and services (or micro-services).
      • Functionality: Kubernetes as a complex installation and setup process, but it not as limited as Docker Swarm.
      • Monitoring: It supports multiple versions of logging and monitoring when the services are deployed within the cluster (Elasticsearch/Kibana (ELK), Heapster/Grafana, Sysdig cloud integration).
      • Scalability: All-in-one framework for distributed systems.
      • Other Benefits: Kubernetes is backed by the Cloud Native Computing Foundation (CNCF), huge community among container orchestration tools, it is an open source and modular tool that works with any OS.
      See more
      Dale Ross
      Independent Contractor at Self Employed · | 22 upvotes · 993.9K views

      I've heard that I have the ability to write well, at times. When it flows, it flows. I decided to start blogging in 2013 on Blogger. I started a company and joined BizPark with the Microsoft Azure allotment. I created a WordPress blog and did a migration at some point. A lot happened in the time after that migration but I stopped coding and changed cities during tumultuous times that taught me many lessons concerning mental health and productivity. I eventually graduated from BizSpark and outgrew the credit allotment. That killed the WordPress blog.

      I blogged about writing again on the existing Blogger blog but it didn't feel right. I looked at a few options where I wouldn't have to worry about hosting cost indefinitely and Jekyll stood out with GitHub Pages. The Importer was fairly straightforward for the existing blog posts.

      Todo * Set up redirects for all posts on blogger. The URI format is different so a complete redirect wouldn't work. Although, there may be something in Jekyll that could manage the redirects. I did notice the old URLs were stored in the front matter. I'm working on a command-line Ruby gem for the current plan. * I did find some of the lost WordPress posts on archive.org that I downloaded with the waybackmachinedownloader. I think I might write an importer for that. * I still have a few Disqus comment threads to map

      See more
      Postman logo

      Postman

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

      related Postman posts

      Noah Zoschke
      Engineering Manager at Segment · | 30 upvotes · 2.1M 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 · | 25 upvotes · 2.1M 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
      Swagger UI logo

      Swagger UI

      1.6K
      1.4K
      201
      A Collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation
      1.6K
      1.4K
      + 1
      201
      PROS OF SWAGGER UI
      • 46
        Open Source
      • 34
        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
        Doesn't generate code snippets in different languages
      • 1
        Documentation doesn't look that good
      • 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 · 2.1M 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 · | 25 upvotes · 2.1M 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
      Apiary logo

      Apiary

      220
      275
      108
      Integrated API documentation, prototyping and testing
      220
      275
      + 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