From 2f2eb67b5fb1598e0ff0fa062bdc1a0bcbbbd8bb Mon Sep 17 00:00:00 2001 From: lgasp Date: Tue, 21 Sep 2021 13:29:59 +0200 Subject: [PATCH] Add a milestone to docs Added: * milestone example * milestone section with short explanation --- docs/gantt.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/gantt.md b/docs/gantt.md index 4e48611d7..4dafff1e9 100644 --- a/docs/gantt.md +++ b/docs/gantt.md @@ -61,6 +61,7 @@ gantt Future task in critical line :crit, 5d Create tests for renderer :2d Add to mermaid :1d + functionality added :milestone section Documentation Describe gantt syntax :active, a1, after des1, 3d @@ -130,6 +131,11 @@ You can divide the chart into various sections, for example to separate differen To do so, start a line with the `section` keyword and give it a name. (Note that unlike with the [title for the entire chart](#title), this name is *required*. +### Milestones + +You can add milestones to the diagrams. Milestones differ from tasks as they represent a signle instant in time and are identifiedd by the keyword `milestone` + + ## Setting dates `dateFormat` defines the format of the date **input** of your gantt elements. How these dates are represented in the rendered chart **output** are defined by `axisFormat`.