JSDoc VS Asciidoctor

JSDoc Reviews

Asciidoctor Reviews

1. Elisa

   | Technical Writer at Self | about 2 years ago
   Professional output from open source

   If you are looking for an open documentation solution ny which you can implement single sourcing while integrating with a complex build process then this is a great solution.

   👍 Pros:    Easy integration|Easy to use

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 / 2 days 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

Asciidoctor mentions (24)

• AsciidocFX: The Asciidoc Editor for documentation and authoring

  AsciidocFX, is an open-source, cross-platform editor that provides an exceptional user experience and a comprehensive set of features for working with Asciidoc files. Though Asciidoctor provides these capabilities, not everyone will be comfortable enough to work in the commandline or shell setting that's where AsciidocFX comes to the rescue. Let's explore some of the key capabilities that make AsciidocFX stand out. - Source: dev.to / 15 days 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 / 4 months ago

• Documentation generators and custom syntax highlighting

  I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:. Source: about 1 year ago

• I wish Asciidoc was more popular

  In fact, also this claim is wrong, because there are three :D 1. https://asciidoctor.org/. - Source: Hacker News / over 1 year ago

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

  Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model and converting it to HTML5, PDF, EPUB3, and other formats. Built-in converters for HTML5, DocBook5, and man pages are available in Asciidoctor. Asciidoctor has an out-of-the-box default stylesheet and built-in integrations for MathJax (display beautiful math in your browser), highlight.js, Rouge, and Pygments (syntax... - Source: dev.to / over 1 year ago