Table of Contents
Asciidoctor
Manual Installation
As used by our Release Automation Tools on offline systems.
Ruby
On Windows:
-
https://rubyinstaller.org/downloads/
-
as of 2025-03-12:
rubyinstaller-3.4.2-1-x64(without devkit) -
install for local user only
-
install MSYS2 base installation
-
reboot computer!
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
gemIn the windows menu look for
Start Command Prompt with Rubyand execute the following commands:$ gem install asciidoctor $ gem install asciidoctor-diagram OR: gem install asciidoctor-kroki $ gem install asciidoctor-diagram-plantuml (only needed, if asciidoctor-diagram is being used) $ gem install asciidoctor-pdf
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.lockand 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-diagramandasciidoctor-pdf.GraphViz
For Asciidoctor to render PlantUML diagrams into image files (using the
asciidoctor-diagramandasciidoctor-diagram-plantumlgems), additional tooling is required. See PlantUML and Graphviz.
Manual Installation by End User
The AsciiDoc Toolkit for LabVIEW will automatically download and install the Asciidoctor toolchain.
For systems without internet access, the toolchain requires a manual installation procedure.
-