List of Asciidoctor Extensions

This page is a catalog of Asciidoctor extensions. In this context, an extension is a library that enriches the AsciiDoc content either by introducing new syntax or weaving additional features into the output. This differs from tool extensions, such as the Atom extension, which bring AsciiDoc support to the tool.

Official Extensions

Name Runtime Description

Asciidoctor Diagram

Asciidoctor

A set of extensions for Asciidoctor that allow you to embed diagrams written using the PlantUML, Graphviz, ditaa, or Shaape syntax inside your AsciiDoc documents.

Asciidoctor LaTeX

Asciidoctor

Makes it possible to convert AsciiDoc documents into LaTeX and HTML. It also brings an extended mathematical syntax for the AsciiDoc markup language that closely parallels LaTeX.

AsciidoctorJ Screenshot

AsciidoctorJ

Automates the inclusion of dynamically-generated screenshots into your documentation.

Extension Lab

Asciidoctor

An experimental playground for upcoming extensions. Used to test the capabilities of the extension mechanism and new extension ideas.

The label “official” simply means that the extension is hosted inside the Asciidoctor organization on GitHub and is maintained as part of the Asciidoctor project. In contrast, a third-party extension is one hosted outside of the Asciidoctor organization. This classification does not indicate the quality of the extension. Instead, the quality should be based on the extension’s own merit.

Third-party Extensions

Name Runtime Description

Asciidoctor Gherkin

AsciidoctorJ

Includes Gherkin feature files in AsciiDoc in the form of sections, paragraphs, lists and tables.

Markup Document Builder

AsciidoctorJ

This project is a document builder for markup documents, including AsciiDoc.

MonoTree

AsciidoctorJ

Visualizes tree-like structures. It takes names for a tree node and its nesting level as an input and draws a tree as an output.

Asciidoctor sdedit

AsciidoctorJ

Creates sequence diagrams using sdedit.

Cukedoctor

AsciidoctorJ

Enables BDD living documentation by integrating Cucumber and Asciidoctor.

Tabbed Code Blocks

AsciidoctorJ

Enables rendering code on multiple tabs.

Asciidoctor Question

Asciidoctor

Asciidoctor Question is a set of Asciidoctor extensions that allows you to add questions as multiple choice and gap text.

Asciidoctor Inter-doc Reference Text

Asciidoctor(.js)

Provides implicit (automatic) reference text (label) for inter-document cross references.

Asciidoctor HTML5s

Asciidoctor(.js)

Alternative HTML5 converter (backend) for Asciidoctor that focuses on correct semantics, accessibility and compatibility with common typographic CSS styles.

Asciidoctor Rouge

Asciidoctor

Highlight source listing blocks using Rouge, a pure-Ruby code highlighter that is compatible with Pygments.

Since Asciidoctor 2.0.0, support for Rouge is provided out of the box, so this extension is no longer required.

Asciidoctor Highlight.js

Asciidoctor.js

Highlight source listing blocks using highlight.js at build-time.

Asciidoctor KaTeX

Asciidoctor(.js)

Convert latexmath to HTML using KaTeX at build-time.

Themes

AsciidoctorJ

A recopilation of differents themes you can apply into your documentation

Google Analytics

AsciidoctorJ

Generate the required javascript to include Google Analytics in the header of the document

Disqus

AsciidoctorJ

Include a block wherever you want to have a Disqus frame and allow live comments from your readers

Collapsable

AsciidoctorJ

Rewrite your TOC with a collapsable menu, usefull if you have a long list of items on it

Copyblocks

AsciidoctorJ

Include a small button in your source blocks to copy the content to the clipboard

Callout Tooltip

AsciidoctorJ

Include a tooltip in your callout visible when the user hover the mouse over it

Google Search

AsciidoctorJ

This asciidoctor-extensions adds the capability to generate the structured data, extracting from your document attribute, required by Google to understands the content of the page

Ensure HTTPS

AsciidoctorJ

Check if the user is reading the https version of your document and redirect to it in case it isn’t

Multi Language

AsciidoctorJ

With this asciidoctor extension you can write in the same file all contents in different languages and allow to the user choose what version want to read

EachFile

AsciidoctorJ

With each-file block processor you define a template block with a qualifier and the processor repeat the template per each file who match the pattern.

BarCode

AsciidoctorJ

Generate barcodes images (13 formats supported, include Ean13, pdf417, QRCode, etc)

Quiz

AsciidoctorJ

experimental extension to generate quizzes integrates in the documentation the user can solve and view his puntuation