xmera-circle / xo_guide

A (german) guide for xmera Omnia

xmera Omnia Guide

Developer project of xmera Omnia Guide

The xmera Omnia Guide 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

Install all dependencies of this project by

npm install

Create xmera Omnia Guide via Makefile

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 Guide © 2022-2023 by xmera Solutions GmbH is licensed under CC BY-SA 4.0.