JSDoc VS Antora

JSDoc Reviews

Antora Reviews

JSDoc mentions (50)

• Deep Dive: Google Apps Script - Testing APIs and Automating Sheets

  Note: For simplicity, I will omit the JavaScript documentation, but for a production grade code you may want to add the documentation (see jsdoc.app website for more). - Source: dev.to / 1 day ago

• Figma's Journey to TypeScript

  You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead. It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are. Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript. [1] https://jsdoc.app/. - Source: Hacker News / 14 days ago

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / 2 months ago

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 3 months ago

• What is JSDoc and why you may not need typescript for your next project?

  There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / 4 months 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