asciidoctor - converts AsciiDoc source files to HTML, DocBook and other formats
The asciidoctor(1) command converts the AsciiDoc source file(s) FILE
HTML5, DocBook 5, DocBook 4.5, man(ual) page and other custom output formats.
then the AsciiDoc source is read from standard input.
Base directory containing the document and
resources. Defaults to the directory containing the source file, or the
working directory if the source is read from a stream. Can be used as a way to
chroot the execution of the program.
Set safe mode level: unsafe,
safe, server or secure. Disables potentially dangerous
macros in source files, such as include::. If not set, the safe mode level
defaults to unsafe when Asciidoctor is invoked using this script.
Set safe mode level to safe. Enables
include macros, but restricts access to ancestor paths of source file.
Provided for compatibility with the asciidoc command. If not set, the safe
mode level defaults to unsafe when Asciidoctor is invoked using this
Define, override or delete a document
attribute. Command-line attributes take precedence over attributes defined in
the source file.
is normally formatted as a key-value pair, in the form
. Alternate acceptable forms are NAME
defaults to an empty string), NAME!
attribute) and NAME=VALUE@
override value of NAME
attribute if it’s already defined in the
source document). Values containing spaces should be enclosed in quotes.
This option may be specified more than once.
Backend output file format: html5,
docbook5, docbook45 and manpage are supported out of the
box. You can also use the backend alias names html (aliased to
html5) or docbook (aliased to docbook5). Defaults to
html5. Other options can be passed, but if Asciidoctor cannot find the
backend, it will fail during conversion.
Document type: article, book,
manpage or inline. Sets the root element when using the
docbook backend and the style class on the HTML body element when using
the html backend. The book document type allows multiple level-0
section titles in a single document. The manpage document type enables
parsing of metadata necessary to produce a manpage. The inline document
type allows the content of a single paragraph to be formatted and returned
without wrapping it in a containing element. Defaults to article.
Compact the output by removing blank lines.
(No longer in use).
Destination output directory. Defaults to the
directory containing the source file, or the working directory if the source
is read from a stream. If specified, the directory is resolved relative to the
Template engine to use for the custom
converter templates. The gem with the same name as the engine will be loaded
automatically. This name is also used to build the full path to the custom
converter templates. If a template engine is not specified, it will be
auto-detected based on the file extension of the custom converter templates
Specifies the eRuby implementation to use for
executing the custom converter templates written in ERB. Supported values are
erb and erubis. Defaults to erb.
Add the specified directory to the load path,
so that -r can load extensions from outside the default Ruby load path.
This option may be specified more than once.
Auto-number section titles. Synonym for
Write output to file OUT_FILE. Defaults
to the base name of the input file suffixed with backend extension. If
the input is read from standard input, then the output file defaults to
stdout. If OUT_FILE is - then the standard output is also used.
If specified, the file is resolved relative to the working directory.
Require the specified library before executing
the processor, using the standard Ruby require. This option may be specified
more than once.
Suppress the document header and footer in the
A directory containing custom converter
templates that override one or more templates from the built-in set. (requires
If there is a subfolder that matches the engine name (if specified), that folder
is appended to the template directory path. Similarly, if there is a subfolder
in the resulting template directory that matches the name of the backend, that
folder is appended to the template directory path.
This option may be specified more than once. Matching templates found in
subsequent directories override ones previously discovered.
Include backtrace information on errors. Not
enabled by default.
Verbosely print processing information and
configuration file checks to stderr.
Display timings information (time to read,
parse and convert).
Show the help message.
Print program version number.
-v can also be used if no other flags or arguments are present.
honors the SOURCE_DATE_EPOCH environment variable. If this
variable is assigned an integer value, that value is used as the epoch of all
input documents and as the local date and time. See ⟨URL:
https://reproducible-builds.org/specs/source-date-epoch/ ⟩ for more
information about this environment variable.
Failure (syntax or usage error; configuration
error; document processing failure; unexpected error).
Refer to the Asciidoctor
issue tracker at ⟨URL:
was written by Dan Allen, Ryan Waldron, Jason Porter, Nick
Hengeveld and other contributors.
was written by Stuart Rackham and has received contributions
from many other individuals.
Project web site:
⟨URL: http://asciidoctor.org ⟩
Git source repository on GitHub:
⟨URL: https://github.com/asciidoctor ⟩
Discussion list / forum:
Copyright (C) 2012-2016 Dan Allen, Ryan Waldron and the Asciidoctor Project.
Free use of this software is granted under the terms of the MIT License.
Dan Allen, Sarah White, Ryan Waldron