Documentation

The documentation should cover everything you need to create a dashboard with inkBoard, and get it running. Both the basics for a configuration, all the types of elements, as well as documentation for integrations and platforms.

Not sure where to get started? If you have not followed it yet, take a look at the tutorial. Otherwise, use the platform emulator, run the designer, and take a look at all the available elements to make a dashboard.

Since the project is still in development, some documented features may not actually be in use yet. A main factor of this is the Styling functionality, which needs to be properly overhauled first.

Types

A primer on various types used throughout this documentation

inkBoard types
Configuration

The basis of a configuration file

base configuration documentation
Elements

All the elements provided by inkBoard out of the box

element documentation
Platforms

Platforms that allow compatible devices to run inkBoard

platform documentation
Integrations

Integrations that extend inkBoard’s functionality

integration documentation