LinuxCommandLibrary

asciidoctor

Convert AsciiDoc documents to various output formats

TLDR

Convert to HTML

$ asciidoctor [document.adoc]
copy
Convert to PDF
$ asciidoctor-pdf [document.adoc]
copy
Convert with custom output
$ asciidoctor -o [output.html] [document.adoc]
copy
Convert with backend
$ asciidoctor -b [docbook] [document.adoc]
copy
Enable safe mode
$ asciidoctor -S [secure] [document.adoc]
copy

SYNOPSIS

asciidoctor [-b backend] [-o output] [-a attribute=value] [options] files

DESCRIPTION

asciidoctor is a fast text processor for converting AsciiDoc markup to HTML, DocBook, man pages, and other formats. It's a Ruby implementation of the AsciiDoc standard, supporting extensions and customization.
AsciiDoc is a lightweight markup language for writing documentation, articles, books, and technical content.

PARAMETERS

-b backend

Output backend (html5, docbook5, manpage)
-o file
Output file
-D dir
Output directory
-a attr=val
Set document attribute
-r lib
Require library/extension
-S level
Safe mode (unsafe, safe, server, secure)
-v, --verbose
Verbose output
--trace
Show backtrace on errors
-s, --no-header-footer
Output without HTML wrapper

CAVEATS

PDF output requires asciidoctor-pdf gem. Some features require additional gems. Safe mode restricts certain features.

HISTORY

Asciidoctor was created by Dan Allen and Ryan Waldron, first released in 2012 as a faster, Ruby-based alternative to the original Python AsciiDoc implementation.

SEE ALSO

asciidoc(1), pandoc(1), markdown(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community