xmera Omnia Documentation

Developer project of xmera Omnia Documentation

The xmera Omnia Documentation is written in AsciiDoc and convertible into HTML by Antora or converitble into a pdf file.

---

Installation

The documentation is based on AsciiDoc. The adoc-files are converted to a HTML documentation by Antora and to a PDF document by Asciidoctor PDF.

So you need to install:

• Antora and
• Antora Lunr Extension
• Asciidoctor PDF

For doing so, make sure you run the latest Node.js LTS version:

node --version
v18.13.0

Follow the instructions for Linux in order to upgrade to the latest LTS version of node.

Install all dependencies of this project by

npm install

Create xmera Omnia Documentation via Makefile

The following commands will build the documentation with all its components.

That is, you need also xo_demo_guide and xo_guide!

Create the Antora HTML pages and start the guide with Firefox:

make html_browser

Create the pages without starting the browser:

make html

Create the pdf document and start the document in the document reader:

make pdf

NOTE The PDF Creator is not working right now!

Changelog

All notable changes to this project will be reported in the changelog.

License

xmera Omnia Documentation © 2022-2023 by xmera Solutions GmbH is licensed under CC BY-SA 4.0.