Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Timelines

sirene draws Mermaid timelines (timeline) as images and as text:

timeline
    title History of Social Media Platform
    2002 : LinkedIn
    2004 : Facebook
         : Google
    2005 : YouTube
    2006 : Twitter
the drawing of the mermaid source above

In the editor a timeline is read-only on the drawing side.

What is read

SyntaxDrawn as
timeline, timeline LR, timeline TDperiods left to right with events below, or top to bottom with events to the right
title textthe title above (frontmatter title too)
2002 : A : Ba period and its events
: C on the next lineanother event for the period above
section namea box over the periods that follow, until the next section
<br>a line break; long text also wraps

A : separates only when followed by a space or the end of the line, so 10:30 : standup is the period 10:30. Each section has its own color; without sections, each period does.

Errors

An event before any period and a section without a name are errors, and an empty event is a warning; the rest of the timeline is drawn.

Colors

Section colors can be overridden with themeVariables.cScale0 to cScale11; see Themes.

Not drawn

disableMulticolor is ignored.