User Tools

Site Tools


kb:common:asciidoctor

This is an old revision of the document!


Asciidoctor

Manual Installation

Ruby

On Windows:

On RHEL:

Disable default Ruby AppStream module on your system

  $ sudo dnf module reset ruby -y

To specify the module version, use the command:

  $ sudo yum install @ruby:3.1

Asciidoctor

Asciidoctor is a Ruby tool and is therefore installed via Ruby's packet manager gem

   $ gem install asciidoctor
   $ gem install asciidoctor-diagram                     OR:       gem install asciidoctor-kroki
   $ gem install asciidoctor-pdf

For RAT: Generation of the diagrams will either take place via the ruby gem asciidoctor-diagram or asciidoctor-kroki. This can be configured via a documentr variable. asciidoctor-diagram requires java and graphviz and asciidoctor-kroki requires communication to a kroki server.

Offline Installation of gems

If no direct network connection is available, you can use Bundler.io to export packages and their dependencies from an online PC.

1. Download bundler from rubygems (latest version at the moment is v2.5.7) and install it locally via

  $ gem install --force --local bundler-2.5.7.gem

2. Download our ready-made Bundler package for local (offline) installation containing all necessary gems. Extract the archive to a local directory.

3. Run the following command from the above directory where the Gemfile, Gemfile.lock and the /vendor/cache/ subdirectory are available:

  $ bundle install --local

Package based Installation (Linux)

Example based on Red Hat Enterprise Linux 8.7.

 $ sudo dnf install asciidoc
 
It's not yet clear if further steps are necessary to install asciidoctor-diagram and asciidoctor-pdf.

PlantUML / GraphViz

See PlantUML

kb/common/asciidoctor.1741784060.txt.gz · Last modified: 2025/03/12 12:54 by alexander.elbert