StackShare
May 1, 2019
Needs advice
382k views382k
CommentsApiary vs Read the Docs vs ReadMe.io
Overview
Share your Stack
Help developers discover the tools you use. Get visibility for your team's tech choices and contribute to the community's knowledge.
CLI (Node.js)
Manual
Advice on Apiary, Read the Docs, ReadMe.io
Detailed Comparison
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. | 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. | 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. |
Documentation- Organized around resources, code samples with syntax highlight, easy to explore.;Inspector- Users can make API calls through apiary.io, we show them how they differ from documentation.;Community- Opensource your API documentation on GitHub. The right channel between developers on both side of the API.;Always Tested [closed alpha]- The documentation is always watching your real API and tells you whenever it gets out of sync.;Server Mock- The fastest way to static API prototype—just ‘document’ your future API and it’s up. 2 minutes to Hello World.;GitHub Integration- Store the API Blueprint in your repository, everything gets updated as soon as you commit a new version.;I/O Validation- Add a JSON Schema to the API Blueprint and the proxy will help your API users understand implementation of data structures better.;Customization [closed alpha]- The documentation and tools can be seamlessly placed on your website and gray-labeled so the friction is close to none. | Github and Bitbucket Integration;Auto-updating;Internationalization;Canonical URLs; Versions;Version Control Support Matrix;PDF Generation;Search;Alternate Domains | 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. |
Statistics | ||
Stacks 241 | Stacks 71 | Stacks 114 |
Followers 325 | Followers 289 | Followers 365 |
Votes 109 | Votes 22 | Votes 69 |
Pros & Cons | ||
Pros
| Pros
| Pros
Cons
|
Integrations | ||
What are some alternatives to Apiary, Read the Docs, 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
Docusaurus
Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
Gelato.io
Gelato.io is a SaaS tool for creating API documentation and developer portals.
MireDot
Generate REST documentation directly from your Java source code. This ensures always up-to-date and accurate documentation with minimal effort.
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.
Slate
Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your 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.
Ardoq
Ardoq's out of the box visualizations are automatically created in real-time. All changes and relationships are visualized simultaneously and are context sensitive. With Ardoq, you can see your documentation in the perspectives that best suit your needs.
Docbloc
It is a REST API documentation management platform. It simplifies the creation and distribution of REST API documentation, leaving you more time to build what matters.
