Asciidoctor pdf is a native pdf converter for asciidoc. The asciidoctorpdf1 command converts the asciidoc source files file to pdf. Well cover the most common usages of the processor in this document. Latex is a typesetting program especially well suited for scientific publications. An asciidoc processor parses the document and translates it into a backend format, such as html, epub, docbook or pdf. Asciidoc is a text document format for writing notes, documentation, articles. Asciidoctor pdf is an asciidoctor extension that converts an asciidoc document directly to a pdf document. Asciidoc fx is a specialized and very functional piece of software that provides you with a set of useful features, advanced format capabilities and support for a wide array of files in order to. The asciidoc a2xformat attribute value is set to format. Using the asciidoctorfopub project, you can convert any docbook file into a nicely formatted pdf with nothing more than a java runtime jvm and development kit jdk. The processor generates the output format using a converter.
To the degree possible, this converter supports all the features of asciidoc that are supported by the builtin converters. Well demonstrate how to generate html5 or pdf from an asciidoc document. Apart from asciidoc 1 and a python interpreter, no other programs are required to convert asciidoc text files to docbook or html. Note that it would have been better to call usrlocalbinasciidoctorpdf. This section describes how to specify the output format. The asciidoctorpdfoptimize is not guaranteed to reduce the size of the pdf file. Use admonition or navigation icon images in output documents. Asciidoc document in a github repository or a gist is automatically converted to html and rendered in the web interface. Complete guide for using asciidoc in linux its foss. This option is only applicable to html based output formats. The easiest way to convert asciidoc document to pdf is as follows.
If you have a project on github, you can write the readme or any other documentation in asciidoc and the github interface will show the html output for visitors to view. Document conversion d, destinationdirdir destination output directory. A path relative to output files containing admonition and navigation icons. Learn how to convert your asciidoc documents directly to pdf using the. The default behavior is to use text in place of icons. You should probably only consider using it if the file size of the original pdf is several megabytes. All the open source software required to perform the conversion is automatically fetched from the internet the first time you run it. Using asciidoc and asciidoctor to write documentation tutorial. The asciidoctor processor is typically used to parse an asciidoc document and convert it to a variety of formats, such as html, docbook, or pdf.
The style and layout of the pdf is controlled by a dedicated theme file. Asciidoc ships with a set of default templates in the tin, but you can customize the templates or create your own to get exactly the output you want. Franck pommereau has written asciidoctest, a program that doctests. Print commandline syntax and program options to stdout. It bypasses the requirement to generate an interim format such as docbook, apache fo, or latex.