Skip to content

The language syntax

Andrea edited this page Aug 13, 2017 · 6 revisions

This article explains the syntax used to create layouts.

Markdown based

The content can be formatted using Markdown. Each single piece of content is called a content block. Connections between blocs are called flows.

Defining blocks

To define a block, one simply starts a new MD <h1>:

# This is a block
This is the content of the block. The ID of the block is: "this-is-a-block".

Fast IDs It is possible to define IDs for each block by using the :: token in the title of the block:

# a::This is a block
This is the content of the block. The ID of the block is either:

- The original title: "this-is-a-block"
- The shortcut: "a"

When rendered, the ID in the title, if present, is stripped, so the block title will be: "This is a block".

IDs are important in order to define flows between blocks.

Creating flows

There are 4 different directional flows which can be specified when connecting two blocks a and b:

  • Down By using syntax a -> b, block b will be rendered below block a.
  • Up By using syntax a <- b, block b will be rendered above block a.
  • Left By using syntax a => b, block b will be rendered on the left of block a.
  • Right By using syntax a <= b, block b will be rendered on the right of block a.
Clone this wiki locally