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. Although the code in this repository is maintained by the Asciidoctor team, the code is untested and should not be used in production. The extensions are only intended to serve as a reference.

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 Multipage

Asciidoctor

A configurable, multipage HTML converter for Asciidoctor. Extends the built-in HTML 5 converter to generate multiple HTML pages from a single source document.

Asciidoctor Open Document

Asciidoctor

A converter for Asciidoctor that allows you to convert an AsciiDoc document into the fodt (flat OpenDocument Text) format.

Asciidoctor Packt

Asciidoctor

A set of converter templates for Asciidoctor that allows you to convert an AsciiDoc document into the fodt (flat OpenDocument Text) format using the template for a Packt manuscript.

Asciidoctor Office

AsciidoctorJ

Provides features to convert Microsoft Excel sheets to AsciiDoc tables and Microsoft PowerPoint slides to images.

Asciidoctor Liquibase

AsciidoctorJ

This AsciidoctorJ extension provides a macro to generate an entity relationship diagram based on Liquibase changeset files.

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 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 repackaging of themes from the Asciidoctor stylesheet factory that you can apply to your documentation.

Google Analytics

AsciidoctorJ

Generate the required JavaScript code to include Google Analytics in the header of the document.

Disqus

AsciidoctorJ

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

Collapsible

AsciidoctorJ

Rewrite your TOC with a collapsible menu, especially useful if you have a large document.

Copyblocks

AsciidoctorJ

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

Callout Tooltip

AsciidoctorJ

Include a tooltip in your callout visible when the user hovers over it with the mouse.

Google Search

AsciidoctorJ

This asciidoctor-extensions adds the capability to generate the structured data—​extracted from document attributes—​that is required by Google to understand the content of the page.

Ensure HTTPS

AsciidoctorJ

Automatically redirects the user to the https version of your document.

Multi Language

AsciidoctorJ

If you write the same file in different languages, this extension adds a UI control that allows to the reader to switch between languages.

EachFile

AsciidoctorJ

With the each-file block processor, you define a template block with a qualifier and the processor will repeat the template for each file that matches the pattern.

Calendar

AsciidoctorJ

Generates a calendar for the specified month that includes the events defined in the contents of the block. Each cell is formatted as an AsciiDoc table cell content, so the event can include icons, STEM, and other content types.

BarCode

AsciidoctorJ

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

Quiz

AsciidoctorJ

An experimental extension to generate interactive quizzes.

Asciidoctor Apidoc

AsciidoctorJ

An inline macro to easily create a link to a Javadoc reference inside an AsciiDoc document.

Asciidoctor P2E

Asciidoctor

Makes it easier to create content for the Pathfinder 2E roleplaying system.

Asciidoctor Lists

Asciidoctor

An asciidoctor extension that adds a list of figures, a list of tables, or a list of anything you want!