Elixeum Documentation

Work-in-progress documentation system which aims to replace Confluence with technical documentation. Please write all new documentation into this system instead of Confluence.

How to write documentation

This is public Elixeum platform documentation soon available on docs.elixeum.cloud. Goals of this documentation is to provide description, examples and guides how to integrate with Elixeum platform.

Create a page

At the beginning just select in which part of documentation your text should be and create sub-folder or just .md file and write your text.

Markdown

All documentation is using Markdown for formatting your text, this documentation system has few extensions like Mermaid for diagrams or tabs for - obviously - tabs which can be used for code examples in various languages.

Some of these are used in rules.md so go and have a look at it 😄

How to start

Due browsers security limitations you can not open directly index.html as it will block loading external resources due file:// protocol. You need to setup simple local server to serve assets, for example you can use Node and pre-existing serve.mjs to start simple HTTP server.

#!/bin/sh
node serve.mjs --verbose --port <port> # Default is 8080

# Or using Bun
bun run serve -- --verbose --port <port>

# Or using Deno
deno run --allow-net --allow-read serve.mjs --verbose --port <port>

You may enable verbose output by passing --verbose flag - this will enable additional logs.

Note that at least Node version 15+ is required.

Docker support

The primary way how to run this is to use Docker and behind reverse proxy. Because of this the Dockerile and compose.yml does not expose any ports, as the container is meant to be behind reverse proxy on same network which will route requests to it.

If you want to test Docker version locally, just expose internal port 80 to something like 8085 on your local network.