Skip to content

Latest commit

 

History

History
111 lines (89 loc) · 4.43 KB

README.md

File metadata and controls

111 lines (89 loc) · 4.43 KB

Timeline

Convert Markdown timeline to Graphviz DOT

Example timeline

Timeline converts parts of Markdown to Graphviz DOT:

  • [node]: http://www.website.com "optional tooltip" to a node external link
  • ## cluster to a cluster
  • - [node] description to a node of the cluster

Node external links are optional, but are expected to be defined before their respective nodes appear. Edges between nodes of the same cluster are possible. Nodes defined before the first cluster are considered free. This README is actually a valid input, open the raw file to see the links.

There are two implementations available. The first one in Ruby reads a Markdown file and direction, README.md and LR by default, and outputs a DOT file. This DOT file contains a graph representation of the timeline, which can be converted into an image format by Graphviz. By using a combination of a HTML and SVG output one can obtain a static timeline page. SVG output is recommended to take full advantage of links and tooltips, see the result here.

ruby timeline.rb README.md LR                   # Generate Left to Right DOT file
..\graphviz\bin\dot.exe README.md.dot -O -T svg # Generate SVG file

The second one is implemented in JavaScript and focuses on client-side rendering with d3-graphviz. This removes the need to install any specific tools, while adding interactivity. This version is able to read a Markdown file (limited to GitHub) and direction from an URL query, edit, display and download their content and graph, see the result here.

https://maumagnaguagno.github.io/Timeline?from=https://maumagnaguagno.github.io/Timeline/README.md&dir=LR

Everything below is valid input for Timeline.

January

February

March

April

May

  • KR Abstracts Submission
  • UAI Notification

June

July

  • SBGames Abstracts Submission
  • KR Notification

August

September

  • ICRA Submission
  • SAC Abstracts Submission
  • AAAI Abstracts Submission
  • EUMAS Abstracts Submission

October

November

December

January