The asciidocLIVE website provides both an editor and previewer. It allows easy loading of an .adoc file and easy exporting to an .html file. Select Settings > Key Bindings > Vim to make the online editor behave like Vim.

1. Linux

1.1. Installation

Either the Linux or Ruby package manager can be used to install Asciidoctor. The Asciidoctor version installed depends on the package manager used. Note that the Linux package managers do not have an asciidoctor-pdf package. Because of this it is recommended to use the Ruby package manager. An additional benefit of using the Ruby package manager is that it installs the latest versions of both asciidoctor and asciidoctor-pdf. The vim-asciidoc package provides syntax support for the Vim editor.

Package Manager asciidoctor asciidoctor-pdf vim-asciidoc

Ruby 1.8.7-2.5.0

1.5.8

1.5.0.alpha.16

-

Debian 8 Jessie

0.1.4-3

-

-

Debian 8 Jessie (Backports)

1.5.4-1~bpo8+1

-

-

Debian 9 Stretch

1.5.4-2

-

8.6.9-5

Debian 9 Stretch (Backports)

1.5.6.2-2~bpo9+1

-

-

Ubuntu 16.04 LTS

1.5.4-1

-

-

Ubuntu 17.10

1.5.5-1

-

8.6.9-5

Ubuntu 18.04 LTS

1.5.5-1

-

8.6.10-2

Windows

1.5.8

1.5.0.alpha.16

-

1.2. Fonts

  • Install fonts needed by asciidoctor-pdf.

  • Enter the following commands at a Command Line.

    sudo apt-get install fonts-thai-tlwg    # Thai fonts.

1.2.1. Karen

  • Enter the following commands at a Command Line.

    sudo mkdir -p /usr/share/fonts/truetype/mmrtext
sudo cp -a /mnt/c/Windows/Fonts/mmrtext* /usr/share/fonts/truetype/mmrtext

1.2.2. Ruby Package Manager

  • Note: Asciidoctor-pdf 1.5.0.alpha.16 using Asciidoctor 1.5.7.1 and earlier work alright with Ruby 2.1.

  • Note: Asciidoctor-pdf 1.5.0.beta.4 using Asciidoctor 2.0.10 and later don’t work anymore with Ruby 2.1.

  • Note: Asciidoctor-pdf 1.5.0.beta.4 using Asciidoctor 2.0.10 and later work alright with Ruby 2.3.

  • Install Ruby 2.3.

  • Enter the following commands at a Command Line.

    sudo gem install asciidoctor
sudo gem install asciidoctor-diagram            (1)
sudo gem install --prerelease asciidoctor-pdf
sudo gem install --prerelease asciidoctor-tabs  (2)
sudo gem install asciidoctor-mathematical       (3)
sudo gem install asciimath                      (3)
sudo gem install concurrent-ruby
sudo gem install gem-path
sudo gem install pygments.rb

gem list | grep -Ei "asciidoctor|asciimath|concurrent-ruby|gem-path|pygments"
    1 Optional: Support for diagrams.
    2 Optional: Support for tabs.
    3 Optional: Support for asciimath (mathematical formulas).

  • Enter the following optional commands at a Command Line.

    sudo gem update asciidoctor
sudo gem update asciidoctor-diagram             (1)
sudo gem update --prerelease asciidoctor-pdf
sudo gem update --prerelease asciidoctor-tabs   (2)
sudo gem update asciidoctor-mathematical        (3)
sudo gem update asciimath                       (3)
sudo gem update concurrent-ruby
sudo gem update gem-path
sudo gem update pygments.rb

gem list | grep -Ei "asciidoctor|asciimath|concurrent-ruby|gem-path|pygments"
    1 Optional: Support for diagrams.
    2 Optional: Support for tabs.
    3 Optional: Support for asciimath (mathematical formulas). 
    which asciidoctor asciidoctor-pdf
asciidoctor --version
asciidoctor-pdf --version

1.3. Usage

Enter the following commands at a Command Line on the TBHF-ANC-MRM server.

cd "/media/Public/SMRU Meeting minutes/IT"
asciidoctor     -a     stylesdir=. -a stylesheet=delta.css "2018-06-13 IT Meeting Minutes.adoc"
asciidoctor-pdf -a pdf-themesdir=. -a  pdf-theme=delta.yml "2018-06-13 IT Meeting Minutes.adoc"
asciidoctor     -a     stylesdir=/home/delta/github/git/delta-software-labs/Documentation -a stylesheet=delta.css "2018-06-13 IT Meeting Minutes.adoc"
asciidoctor-pdf -a pdf-themesdir=/home/delta/github/git/delta-software-labs/Documentation -a  pdf-theme=delta.yml "2018-06-13 IT Meeting Minutes.adoc"

2. Windows

2.1. Installation

  • Install Ruby.

  • Optional diagrams support: Install Java Runtime Environment.

  • Optional source code highlighting support: Install Python.

  • Optional syntax highlighting support: Install Vim.

Enter the following commands at a Command Line.

gem install asciidoctor
gem install asciidoctor-diagram                 (1)
gem install --prerelease asciidoctor-pdf
gem install --prerelease asciidoctor-tabs       (2)
gem install asciidoctor-mathematical            (3)
gem install asciimath                           (3)
gem install concurrent-ruby                     (4)
gem install gem-path                            (5)
1 Optional: Support for diagrams.
2 Optional: Support for tabs.
3 Optional: Support for asciimath (mathematical formulas).
4 To dispose of the following warning when creating a pdf file. asciidoctor: WARNING: gem 'concurrent-ruby' is not installed. This gem is recommended when registering custom converters.
5 Find the Asciidoctor installation path using: gem path asciidoctor. Needed to locate the default Asciidoctor css file.

Enter the following optional commands at a Command Line.

gem install pygments.rb
asciidoctor --version
asciidoctor-pdf --version

2.2. Windows Firewall

■ Domain networks
■ Private networks
■ Public networks

Click Allow access.

2.3. Usage

Enter the following commands at a Command Line.

cd /d "P:\SMRU Meeting minutes/IT"
asciidoctor     -a     stylesdir=. -a stylesheet=delta.css "2018-06-13 IT Meeting Minutes.adoc"
asciidoctor-pdf -a pdf-themesdir=. -a  pdf-theme=delta.yml "2018-06-13 IT Meeting Minutes.adoc"
asciidoctor     -a     stylesdir=/home/delta/github/git/delta-software-labs/Documentation -a stylesheet=delta.css "2018-06-13 IT Meeting Minutes.adoc"
asciidoctor-pdf -a pdf-themesdir=/home/delta/github/git/delta-software-labs/Documentation -a  pdf-theme=delta.yml "2018-06-13 IT Meeting Minutes.adoc"