ReadMe VS Antora

ReadMe Reviews

Antora Reviews

ReadMe mentions (18)

• A list of SaaS, PaaS and IaaS offerings that have free tiers of interest to devops and infradev

  Readme.com — Beautiful documentation made easy, free for Open Source. - Source: dev.to / 3 months ago

• Serverless Semantic Search, Free tier only

  I believe they are using https://readme.com/. - Source: Hacker News / 10 months ago

• Public API documentation. What to use?

  Seems more expensive that readme.com!!! But looks really good! Source: 12 months ago

• Public API documentation. What to use?

  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: 12 months ago

• Documenting a Go API with OpenAPI 3 Standard: A Practical Guide

  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 / about 1 year ago

Antora mentions (21)

• I don't always use LaTeX, but when I do, I compile to HTML (2013)

  You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ). - Source: Hacker News / 4 months ago

• Quarkus : Greener, Better, Faster, Stronger

  Well scaffolding an extension also generates a docs module wich leverages Antora, and with a minimal effort, we can produce a nice and clean documentation. - Source: dev.to / 7 months ago

• Docs as Code at Linode (2020)

  AsciiDoc has a bit more features compared to Markdown which allows for a richer presentation of the docs. Biggest difference is that Linode has the docs in a separate repository. Not sure if it is a limitation of their toolchain or a deliberate decision. Antora allows you to have the project documentation in the actual project repositories. It then pulls the docs from all the different repos together to build the... - Source: Hacker News / 10 months ago

• Ideas on improving internal technical documentation`

  I've been pushing for Antora everywhere I go. It allows you to keep text-based (AsciiDoc, similar to markdown but an actual standard) documentation with your repositories and from that build a central documentation portal site. Source: about 1 year ago

• I wish Asciidoc was more popular

  We use AsciiDoc for our technical documentation, and it's great. Last year we moved from AsciiDoctor to Antora [1] and I can't recommend it enough. [1] https://antora.org/. - Source: Hacker News / over 1 year ago