Antora Reviews and details

Social recommendations and mentions

• Asciidoctor: A fast text processor and publishing toolchain

  Very underappreciated project, for multiple repo online docs there's https://antora.org it is built on Asciidoctor.js, a powerful tool but the learning curve can be steep. - Source: Hacker News / 3 months ago

• 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 / 10 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 / about 1 year 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 / over 1 year 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: over 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 / almost 2 years ago

• Why isn't there a free tier of MadCap Flare for sample projects or self learning?

  Antora: adoc framework for when things get crazy Https://antora.org/. Source: almost 2 years ago

• Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code

  Unlike docToolchain or Asciidoctor, Antora is a true framework for Asciidoc that can store, retrieve, and aggregate all Asciidoc content from multiple git repositories. Antora’s page referencing system isn’t coupled to filesystem paths or URLs. You are able to cross reference pages across a local machine, a staging environment, and a production environment. To generate a site with Antora, you need the Antora CLI... - Source: dev.to / almost 2 years ago

• GF2++

  This project is quite technical and therefore of limited general interest but the documentation site also has some documentation strategy notes that discuss the experience of using AsciiDoc and Antora for the long form documentation. It covers some of the positives and negatives of that experience and may be of interest in its own right particularly for those thinking about going down this road for other smaller... Source: almost 2 years ago

• Docs as code vs a tool that can work with .md and xml?

  Antora is a static site generator for AsciiDoc that can do things like pull content from multiple Git repos and built it together into one site: https://antora.org/. Source: about 2 years ago

• What cloud app to use for structured software documentation?

  When time comes to start thinking about a build engine for lots of complex deliverables, Antora is the current best candidate Https://antora.org/. Source: about 2 years ago

• What's your documentation stack?

  We use Antora and Asciidoc, published as in Gitlab pages, for technical documentation. Source: over 2 years ago

• Dive into Systems: A Free, Online Textbook for Introducing Computer Systems

  I was interested in the tool(s) they used to generate the Web version of the book. They used a tool named Antora [1], which is designed for AsciiDoc. [1] https://antora.org/. - Source: Hacker News / over 2 years ago

• Write Plain Text Files

  I think of it as "content and presentation should be as independent as possible". This is the content side: don't bother with fancy unreadable formats. I've been thinking about this as I try to think about my own personal website. I'd like to have my content versioned, but, was really not loving the idea of tying myself to even a static website generator. This is where I still ponder an approach more like antora... - Source: Hacker News / almost 3 years ago

• Ask HN: What do people use for documentation sites these days?

  I switched from Google Sites to https://antora.org/ for https://hashbackup.com Antora is a little hard to get started because it invents some new concepts, like "component version", but I thought the out-of-the-box formatting was nice. I did spend a little time tweaking things after the site was converted, but not much. The guy who wrote it, Dan, is on a Zulip forum and is great about offering tips for things you... - Source: Hacker News / almost 3 years ago

• Discord is a black hole for information. - Knockout Forums

  I'm a big fan of Antora myself. You can document in AsciiDoc and keep the documentation in the Git repo of your project. Antora can then gather everything together into one large documentation portal. It also has tons of plugins, for example for PlantUML. Source: almost 3 years ago

• Generating documentation sites for Maven projects

  That's really cool. I also have the same struggle, but I use Antora: https://antora.org/. Source: almost 3 years ago

• GIT Publishing Options

  If you want to stay with Git (it's Git, not GIT), then look at AsciiDoc and Antora. Antora can pull from multiple Git repos and build a documentation site. (https://antora.org/). Source: over 3 years ago

• Caffeinated post: Documentation, how to do it

  As for tooling; look at antora. It's a static site generator that lets you create documentation in AsciiDoc or Markdown inside your repository and then create documentation from that. What's also really neat is that it can combine documentation from multiple repositories into a single 'site'. Source: over 3 years ago

• Technical documentation that just works

  Especially when combined with Antora (https://antora.org). - Source: Hacker News / over 3 years ago

• Why software engineers don't write documentation - it's bloody hard!

  Use antora to write docs https://antora.org/. Source: over 3 years ago