Slate API Docs Generator VS Asciidoctor

Slate API Docs Generator 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

Slate API Docs Generator mentions (13)

• How do i document my api ?

  Https://github.com/slatedocs/slate this ! Big company use it ( stripe etc ). Source: about 1 year ago

• [ARTICLE] Stripe Releases Their Documentation Framework

  The second most common question being "What framework does Stripe use to build their documentation?" and the answer has unfortunately always been "They use a custom setup they built themselves and isn't available." － so then Slate gets brought up as a suitable replacement. Source: almost 2 years ago

• Twelve Amazing Free Hugo Documentation Themes

  DocuAPI is a multilingual API documentation theme for Hugo created and maintained by Bjørn Erik Pedersen, the lead maintainer and co-creator of Hugo itself. It’s built on top of the Slate API docs generator, which itself was inspired by Stripe’s and PayPal’s API docs. The JavaScript section of DocuAPI has been rewritten from Jquery to AlpineJS.​​​​​​. - Source: dev.to / almost 2 years ago

• Best way to document Express API

  I've used Slate to document APIs which similarly will produce a local website. You can host that privately or there's built in support to push to github pages if you're hosting it in a github repo. The documentation itself is all written in markdown and managed separate from your API code. Source: almost 2 years ago

• Building API Docs

  We used to use Slate - https://github.com/slatedocs/slate for our APIs in my previous job. That was pretty neat. - Source: Hacker News / about 2 years ago

Asciidoctor mentions (23)

• 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 / 3 months ago

• Documentation generators and custom syntax highlighting

  I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:. Source: 12 months 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 / about 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

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

  If you're looking at AsciiDoc, you'll want to look at Asciidoctor: https://asciidoctor.org/. Source: over 1 year ago