v1.5.7, 2018-05-02 :idprefix: :idseparator: - :source-language: ruby :icons: font :release-version: 1.5.7.1 :uri-org: https://github.com/asciidoctor :uri-project: https://asciidoctor.org :uri-rel-file-base: link: :uri-rel-tree-base: link: :uri-discuss: http://discuss.asciidoctor.org :uri-irc: irc://irc.freenode.org/#asciidoctor :uri-rubygem: https://rubygems.org/gems/asciidoctor :uri-install-docker: https://github.com/asciidoctor/docker-asciidoctor :uri-gitscm-repo: https://github.com/git/git-scm.com :uri-freesoftware: https://www.gnu.org/philosophy/free-sw.html :uri-foundation: https://foundation.zurb.com :uri-tilt: https://github.com/rtomayko/tilt :uri-ruby: https://www.ruby-lang.org :image-uri-screenshot: https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/screenshot.png

Asciidoctor can be run on the JVM using AsciidoctorJ and in all JavaScript environments using Asciidoctor.js.

This document is also available in the following languages:
| |

Key documentation

Sponsors

We want to recognize our generous sponsors, without whose support Asciidoctor would not be possible. Thank you sponsors for your dedication to improving the state of technical documentation!

image:https://www.okta.com/sites/all/themes/Okta/images/blog/Logos/Okta_Logo_BrightBlue_Medium.png[Okta,280,link=https://developer.okta.com/signup?utm_source=asciidoctor&utm_medium=logo&utm_campaign=sponsor,title="Add User Auth to Your Apps in Minutes with Okta"]       image:https://secure.gravatar.com/avatar/823717a797dbd78ceff7b26aa397f383.png?size=200[OpenDevise,100,link=https://opendevise.com,title="Let the Creators of Asciidoctor and Antora Help You to Accelerate Your Docs"]

Major funding for Asciidoctor is provided by our Change Makers, Okta and OpenDevise, and our Strategy Sponsors, Khronos Group and Linda Roberts. Additional funding is provided by our Community Backers.

You can support this project by becoming a sponsor on OpenCollective.

The Big Picture

Asciidoctor reads content written in plain text, as shown in the panel on the left in the image below, and converts it to HTML5, as shown rendered in the right panel. Asciidoctor applies a default stylesheet to the HTML5 document to provide a pleasant out-of-the-box experience.

AsciiDoc Processing

Asciidoctor reads and parses text written in the AsciiDoc syntax, then feeds the parse tree to a set of built-in converters to produce HTML5, DocBook 5 (or 4.5) or man(ual) page output.

Note
Asciidoctor is a drop-in replacement for the original AsciiDoc Python processor (asciidoc.py).

In addition to the classic AsciiDoc syntax, Asciidoctor recognizes additional markup and formatting options, such as font-based icons (e.g., +icon:fire[]+) and UI elements (e.g., +button:[Save]+).

Where Ruby goes, Asciidoctor follows

You can run Asciidoctor on the JVM using JRuby. There are plugins available, based on AsciidoctorJ, that integrate the Asciidoctor processor into Apache Maven, Gradle or Javadoc builds.

Asciidoctor also runs in JavaScript. Asciidoctor.js is used to power the AsciiDoc preview extensions for Chrome, Atom, Brackets and other web-based tooling.

Requirements

  • Ruby (MRI/CRuby 1.8.7 - 2.5)

  • JRuby (1.7 in Ruby 1.8 and 1.9 modes, 9000)

  • Rubinius 2.2.x

  • Opal (JavaScript)

We welcome your help testing Asciidoctor on these and other platforms. Refer to the [Contributing] section to learn how to get involved.

Caution

If you’re using a non-English Windows environment, you may bump into an Encoding::UndefinedConversionError when invoking Asciidoctor. To solve this issue, we recommend changing the active code page in your console to UTF-8:

chcp 65001

Once you make this change, all your Unicode headaches will be behind you. If you’re using an IDE like Eclipse, make sure you set the encoding to UTF-8 there as well. Asciidoctor works best when you use UTF-8 everywhere.

Installation

Asciidoctor can be installed using (a) the gem install command, (b) Bundler, (c) package managers for popular Linux distributions, or (d) Homebrew for macOS.

Tip
The benefit of using a Linux package manager to install the gem is that it handles installing Ruby and the RubyGems library if those packages are not already installed on your machine. The drawback is that the package may not be available immediately after the release of the gem. If you need the latest version, you can always fallback to using the gem command.

(a) gem install

Open a terminal and type (excluding the leading $):

$ gem install asciidoctor

If you want to install a pre-release version (e.g., a release candidate), use:

$ gem install asciidoctor --pre
Tip
Upgrading your installation

If you have an earlier version of Asciidoctor installed, you can update it using:

$ gem update asciidoctor

If you install a new version of the gem using gem install instead of gem update, you’ll have multiple versions installed. If that’s the case, use the following gem command to remove the old versions:

$ gem cleanup asciidoctor

(b) Bundler

  1. Create a Gemfile in the root folder of your project (or the current directory)

  2. Add the asciidoctor gem to your Gemfile as follows:

    source 'https://rubygems.org'
    gem 'asciidoctor'
    # or specify the version explicitly
    # gem 'asciidoctor', '{release-version}'
  3. Save the Gemfile

  4. Open a terminal and install the gem using:

    $ bundle

To upgrade the gem, specify the new version in the Gemfile and run bundle again. Using bundle update is not recommended as it will also update other gems, which may not be the desired result.

(c) Linux package managers

DNF (Fedora 21 or greater)

To install the gem on Fedora 21 or greater using dnf, open a terminal and type:

$ sudo dnf install -y asciidoctor

To upgrade the gem, use:

$ sudo dnf update -y asciidoctor
Tip
Your system may be configured to automatically update rpm packages, in which case no action is required by you to update the gem.

apt-get (Debian or Ubuntu)

To install the gem on Debian or Ubuntu, open a terminal and type:

$ sudo apt-get install -y asciidoctor

To upgrade the gem, use:

$ sudo apt-get upgrade -y asciidoctor
Tip
Your system may be configured to automatically update deb packages, in which case no action is required by you to update the gem.

The version of Asciidoctor installed by the package manager (apt-get) may not match the latest release of Asciidoctor. Consult the package repository for your distribution to find out which version is packaged per distribution release.

Caution

You’re advised against using the gem update command to update a gem managed by the package manager. Doing so puts the system into an inconsistent state as the package manager can no longer track the files (which get installed under /usr/local). Simply put, system gems should only be managed by the package manager.

If you want to use a version of Asciidoctor that is newer than what is installed by the package manager, you should use RVM to install Ruby in your home directory (i.e., user space). Then, you can safely use the gem command to install or update the Asciidoctor gem. When using RVM, gems are installed in a location isolated from the system.

apk (Alpine Linux)

To install the gem on Alpine Linux, open a terminal and type:

$ sudo apk add asciidoctor

To upgrade the gem, use:

$ sudo apk add -u asciidoctor
Tip
Your system may be configured to automatically update apk packages, in which case no action is required by you to update the gem.

(d) Homebrew (macOS)

You can use Homebrew to install Asciidoctor on macOS. If you haven’t yet installed Homebrew, follow the instructions at brew.sh.

Once Homebrew is installed, you can install the asciidoctor gem using the asciidoctor package. To do so, open a terminal and type:

$ brew install asciidoctor

To upgrade the gem, use:

$ brew update
$ brew upgrade asciidoctor
Tip
Homebrew installs the asciidoctor gem into an exclusive prefix that’s independent of system gems.

Other installation options

Usage

If the Asciidoctor gem installed successfully, the asciidoctor command line interface (CLI) will be available on your PATH. To verify it’s available, run the following in your terminal:

$ asciidoctor --version

You should see information about the Asciidoctor version and your Ruby environment printed in the terminal.

Asciidoctor {release-version} [https://asciidoctor.org]
Runtime Environment (ruby 2.4.1p111 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:- ex:UTF-8)

Asciidoctor also provides an API.

Command line interface (CLI)

The asciidoctor command allows you to invoke Asciidoctor from the command line (i.e., a terminal).

The following command converts the file README.adoc to HTML and saves the result to the file README.html in the same directory. The name of the generated HTML file is derived from the source file by changing its file extension to .html.

$ asciidoctor README.adoc

You can control the Asciidoctor processor by adding various flags and switches, which you can learn about using:

$ asciidoctor --help

For instance, to write the file to a different directory, use:

$ asciidoctor -D output README.adoc

Refer to the following resources to learn more about how to use the asciidoctor command.

Ruby API

To use Asciidoctor in your application, you first need to require the gem:

require 'asciidoctor'

You can then convert an AsciiDoc source file to an HTML file using:

Asciidoctor.convert_file 'README.adoc', to_file: true, safe: :safe
Warning
When using Asciidoctor via the API, the default safe mode is :secure. In secure mode, several core features are disabled, including the include directive. If you want to enable these features, you’ll need to explicitly set the safe mode to :server (recommended) or :safe.

You can also convert an AsciiDoc string to embeddable HTML (for inserting in an HTML page) using:

content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
Asciidoctor.convert content, safe: :safe

If you want the full HTML document, enable the header_footer option as follows:

content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
html = Asciidoctor.convert content, header_footer: true, safe: :safe

If you need access to the parsed document, you can split the conversion into discrete steps:

content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
document = Asciidoctor.load content, header_footer: true, safe: :safe
puts document.doctitle
html = document.convert

Keep in mind that if you don’t like the output Asciidoctor produces, you can change it! Asciidoctor supports custom converters that can handle converting from the parsed document to the generated output.

One easy way to customize the output piecemeal is by using the template converter.

However you go about it, you can have 100% control over the output.

Contributing

If you discover errors or omissions in the source code, documentation, or website content, please don’t hesitate to submit an issue or open a pull request with a fix. New contributors are always welcome!

Here are some ways you can contribute:

  • by using prerelease (alpha, beta or preview) versions

  • by reporting bugs

  • by suggesting new features

  • by writing or editing documentation

  • by writing specifications

  • by writing code — No patch is too small.

    • fix typos

    • add comments

    • clean up inconsistent whitespace

    • write tests!

  • by refactoring code

  • by reviewing patches

Getting Help

The Asciidoctor project is developed to help you easily write and publish your content. But we can’t do it without your feedback! We encourage you to ask questions and discuss any aspects of the project on the discussion list, on Twitter or in the chat room.

Discussion list (Nabble)

Twitter

#asciidoctor hashtag or @asciidoctor mention

Chat (Gitter)

image:https://badges.gitter.im/Join%20In.svg[Gitter, link=https://gitter.im/asciidoctor/asciidoctor]

The Asciidoctor organization on GitHub hosts the project’s source code, issue tracker, and sub-projects.

Source repository (git)

Issue tracker

Asciidoctor organization on GitHub

Copyright © 2012-2018 Dan Allen, Ryan Waldron and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License.

Authors

AsciiDoc was started by Stuart Rackham and has received contributions from many other individuals in the AsciiDoc community.

Changelog