Timeline Generator CLI

Generate a timeline from a YAML file. Multiple export formats are supported (TimelineJS, Vis.js, Mermaid, Bootstrap). Data can be filtered.

Usage

Windows

TimelineGenerator.exe sample sample.yml

TimelineGenerator.exe generate -e timelinejs sample.yml timeline
TimelineGenerator.exe generate -e visjs sample.yml timeline
TimelineGenerator.exe generate -e mermaid sample.yml timeline
TimelineGenerator.exe generate -e bootstrap sample.yml timeline

Linux

TimelineGenerator sample sample.yml

TimelineGenerator generate -e timelinejs sample.yml timeline
TimelineGenerator generate -e visjs sample.yml timeline
TimelineGenerator generate -e mermaid sample.yml timeline
TimelineGenerator generate -e bootstrap sample.yml timeline

Installation

Download the latest version from the releases page.

Export formats

TimelineJS

TimelineJS is a free, easy-to-use tool for telling stories in a timeline format.

Vis.js

Vis.js Timeline is a dynamic, interactive timeline library.

Mermaid

Mermaid is a simple markdown-like script language for generating charts from text via javascript.

Exporter will generate a markdown file containing the Mermaid code. Only date and title are supported. Categories are used as sections.

Bootstrap

Bootstrap v5 is a free and open-source CSS framework directed at responsive, mobile-first front-end web development.

Todos

• Define YAML format
• YAML parser
• CLI parser using spectre
  • sample
  • generate
• Add export format for TimelineJS V3 Repo
• Add export format for Vis.js Timeline Repo
• Add export format for Mermaid in Markdown codeblock
• Add export format for Bootstrap v5
• CLI filter parameters: date range, tags, category