Asciidoctor VS DocFX

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

DocFX Reviews

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 / 19 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

DocFX mentions (7)

• TSDocs.dev: type docs for any JavaScript library

  This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool? https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://dotnet.github.io/docfx/ I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated... - Source: Hacker News / 5 months ago

• What Does Microsoft Use to Create their KB Articles?

  Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/. Source: over 2 years ago

• Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?

  We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead. Source: over 2 years ago

• CSharp Docuementation Site

  I use docfx from microsoft to generate documentation for all my oss libraries. Source: over 2 years ago

• What platform is Microsoft Docs hosted on?

  My best guess would be that there's a CI/CD pipeline in GitHub that utilizes DocFX to convert the Markdown files to HTML. The constructed HTML files are then placed in an Azure Storage account that configured for Static Website Hosting combined with Azure CDN. Source: over 2 years ago