Update docs

This commit is contained in:
sidharthv96
2023-06-29 05:16:38 +00:00
parent 3fac8d7be5
commit 85fdbab6b9

View File

@@ -25,25 +25,25 @@ Mermaid can render Gantt diagrams as SVG, PNG or a MarkDown link that can be pas
```mermaid-example ```mermaid-example
gantt gantt
title A Gantt Diagram title A Gantt Diagram
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
section Section section Section
A task :a1, 2014-01-01, 30d A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d Another task :after a1, 20d
section Another section Another
Task in sec :2014-01-12 , 12d Task in Another :2014-01-12, 12d
another task : 24d another task :24d
``` ```
```mermaid ```mermaid
gantt gantt
title A Gantt Diagram title A Gantt Diagram
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
section Section section Section
A task :a1, 2014-01-01, 30d A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d Another task :after a1, 20d
section Another section Another
Task in sec :2014-01-12 , 12d Task in Another :2014-01-12, 12d
another task : 24d another task :24d
``` ```
## Syntax ## Syntax
@@ -117,17 +117,17 @@ gantt
It is possible to set multiple dependencies separated by space: It is possible to set multiple dependencies separated by space:
```mermaid-example ```mermaid-example
gantt gantt
apple :a, 2017-07-20, 1w apple :a, 2017-07-20, 1w
banana :crit, b, 2017-07-23, 1d banana :crit, b, 2017-07-23, 1d
cherry :active, c, after b a, 1d cherry :active, c, after b a, 1d
``` ```
```mermaid ```mermaid
gantt gantt
apple :a, 2017-07-20, 1w apple :a, 2017-07-20, 1w
banana :crit, b, 2017-07-23, 1d banana :crit, b, 2017-07-23, 1d
cherry :active, c, after b a, 1d cherry :active, c, after b a, 1d
``` ```
### Title ### Title
@@ -146,22 +146,22 @@ You can add milestones to the diagrams. Milestones differ from tasks as they rep
```mermaid-example ```mermaid-example
gantt gantt
dateFormat HH:mm dateFormat HH:mm
axisFormat %H:%M axisFormat %H:%M
Initial milestone : milestone, m1, 17:49,2min Initial milestone : milestone, m1, 17:49, 2m
taska2 : 10min Task A : 10m
taska3 : 5min Task B : 5m
Final milestone : milestone, m2, 18:14, 2min Final milestone : milestone, m2, 18:08, 4m
``` ```
```mermaid ```mermaid
gantt gantt
dateFormat HH:mm dateFormat HH:mm
axisFormat %H:%M axisFormat %H:%M
Initial milestone : milestone, m1, 17:49,2min Initial milestone : milestone, m1, 17:49, 2m
taska2 : 10min Task A : 10m
taska3 : 5min Task B : 5m
Final milestone : milestone, m2, 18:14, 2min Final milestone : milestone, m2, 18:08, 4m
``` ```
## Setting dates ## Setting dates
@@ -296,29 +296,27 @@ Comments can be entered within a gantt chart, which will be ignored by the parse
```mermaid-example ```mermaid-example
gantt gantt
title A Gantt Diagram title A Gantt Diagram
%% this is a comment %% This is a comment
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
section Section section Section
A task :a1, 2014-01-01, 30d A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d Another task :after a1, 20d
section Another section Another
Task in sec :2014-01-12 , 12d Task in Another :2014-01-12, 12d
another task : 24d another task :24d
``` ```
```mermaid ```mermaid
gantt gantt
title A Gantt Diagram title A Gantt Diagram
%% this is a comment %% This is a comment
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
section Section section Section
A task :a1, 2014-01-01, 30d A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d Another task :after a1, 20d
section Another section Another
Task in sec :2014-01-12 , 12d Task in Another :2014-01-12, 12d
another task : 24d another task :24d
``` ```
## Styling ## Styling
@@ -440,7 +438,7 @@ Beginner's tip—a full example using interactive links in an html context:
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
section Clickable section Clickable
Visit mermaidjs :active, cl1, 2014-01-07, 3d Visit mermaidjs :active, cl1, 2014-01-07, 3d
Print arguments :cl2, after cl1, 3d Print arguments :cl2, after cl1, 3d
Print task :cl3, after cl2, 3d Print task :cl3, after cl2, 3d