Merge pull request #1631 from mermaid-js/bug/improve_docs_gantt_example

Improve gantt example in documentation
This commit is contained in:
GDFaber 2020-08-20 00:56:27 +02:00 committed by GitHub
commit 7bb4f5591c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -43,65 +43,66 @@ gantt
``` ```
gantt gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
excludes weekends
%% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
dateFormat :YYYY-MM-DD section Critical tasks
title :Adding GANTT diagram functionality to mermaid Completed task in the critical line :crit, done, 2014-01-06,24h
excludes :excludes the named dates/days from being included in a charted task.. Implement parser and jison :crit, done, after des1, 2d
%% (Accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".) Create tests for parser :crit, active, 3d
section A section Future task in critical line :crit, 5d
Completed task :done, des1, 2014-01-06,2014-01-08 Create tests for renderer :2d
Active task :active, des2, 2014-01-09, 3d Add to mermaid :1d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks section Documentation
Completed task in the critical line :crit, done, 2014-01-06,24h Describe gantt syntax :active, a1, after des1, 3d
Implement parser and jison :crit, done, after des1, 2d Add gantt diagram to demo page :after a1 , 20h
Create tests for parser :crit, active, 3d Add another diagram to demo page :doc1, after a1 , 48h
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to mermaid :1d
section Documentation section Last section
Describe gantt syntax :active, a1, after des1, 3d Describe gantt syntax :after doc1, 3d
Add gantt diagram to demo page :after a1 , 20h Add gantt diagram to demo page :20h
Add another diagram to demo page :doc1, after a1 , 48h Add another diagram to demo page :48h
```
section Last section
Describe gantt syntax :after doc1, 3d
Add gantt diagram to demo page :20h
Add another diagram to demo page :48h
```
```mermaid ```mermaid
gantt gantt
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid title Adding GANTT diagram functionality to mermaid
excludes weekends
%% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
section A section section A section
Completed task :done, des1, 2014-01-06,2014-01-08 Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d Future task2 : des4, after des3, 5d
section Critical tasks section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d Future task in critical line :crit, 5d
Create tests for renderer :2d Create tests for renderer :2d
Add to mermaid :1d Add to mermaid :1d
section Documentation section Documentation
Describe gantt syntax :active, a1, after des1, 3d Describe gantt syntax :active, a1, after des1, 3d
Add gantt diagram to demo page :after a1 , 20h Add gantt diagram to demo page :after a1 , 20h
Add another diagram to demo page :doc1, after a1 , 48h Add another diagram to demo page :doc1, after a1 , 48h
section Last section section Last section
Describe gantt syntax :after doc1, 3d Describe gantt syntax :after doc1, 3d
Add gantt diagram to demo page :20h Add gantt diagram to demo page :20h
Add another diagram to demo page :48h Add another diagram to demo page :48h
``` ```
It is possible to set multiple depenendenies separated by space: It is possible to set multiple depenendenies separated by space:
``` ```