Available Converters

Asciidoctor parses AsciiDoc documents and then uses a converter to generate the output format of your choice, such as HTML, DocBook, or PDF.

What’s a converter?

A converter takes AsciiDoc and transforms it into another format. Each converter produces a specific output format, such as HTML or DocBook XML.

Asciidoctor provides several built-in converters and the ability to add on other converters. In addition to generating traditional articles and books from AsciiDoc documents, you can also use Asciidoctor to create HTML-based slide decks, static websites, and documentation sites. When using these add-on converters, you may need to add some additional structure rules to a document. However, nothing in this structure restricts you from still being able to publish the content as a normal document, too.

Each converter is mapped to a name that you specify using the -b (--backend) command line option or backend API option.

Built-in converters

These built-in converters are bundled with Asciidoctor.

HTML

The HTML 5 converter (html or html5) generates HTML 5 styled with CSS3. This is the converter Asciidoctor uses by default.

XHTML

The XHTML variant of the HTML 5 converter. To use the XHTML converter, assign xhtml or xhtml5 to the backend option.

DocBook

The DocBook 5.0 converter generates DocBook 5.0 XML. To use the DocBook converter, assign docbook or docbook5 to the backend option.

Man page

The man page converter generates manual pages for software used on Unix and Unix-like operating systems. To use the man page converter, assign manpage to the backend option.

Add-on converters

You can use add-on converters, which plug into Asciidoctor by adding the appropriate library to the runtime path (e.g., -r asciidoctor-pdf).

PDF

The PDF converter (pdf) generates a portable document format. Requires the asciidoctor-pdf gem.

EPUB3

The EPUB3 converter (epub3) generates a distribution and interchange format standard for digital publications and documents. Requires the asciidoctor-epub3 gem.

Reveal.js

The Reveal.js converter generates a Reveal.js presentation from an AsciiDoc document. Requires Asciidoctor Reveal.js.

Bespoke

The Bespoke converter generates a Bespoke presentation from an AsciiDoc document. Requires Asciidoctor Bespoke.