diff --git a/docs/syntax/gantt.md b/docs/syntax/gantt.md index 31bac5e29a..7b1f527c10 100644 --- a/docs/syntax/gantt.md +++ b/docs/syntax/gantt.md @@ -337,6 +337,56 @@ gantt ``` > **Warning** > `millisecond` and `second` support was added in v10.3.0 +> +> ### Changing Today (v\+) +> +> By default, the today marker uses the current date. Use `today` to set a custom date, using the `dateFormat`. +> +> ```mermaid-example +> gantt +> title A Gantt Diagram With Custom Today +> dateFormat YYYY-MM-DD +> today 2024-01-20 +> section Section +> A task :a1, 2024-01-01, 30d +> Another task :after a1, 20d +> ``` + +You can also use a duration: + +```mermaid-example +--- +displayMode: compact +--- +gantt + title A Gantt Diagram With Custom Today (Duration) + dateFormat x + axisFormat %L ms + today 18ms + todayMarker stroke-width:2px,stroke:#FF0,opacity:0.5 + section Graphics + Draw 1: a1, 0, 28ms + Draw 2: after a1, 20ms + section Compute + Kernel: b1, 20, 12ms +``` + +```mermaid +--- +displayMode: compact +--- +gantt + title A Gantt Diagram With Custom Today (Duration) + dateFormat x + axisFormat %L ms + today 18ms + todayMarker stroke-width:2px,stroke:#FF0,opacity:0.5 + section Graphics + Draw 1: a1, 0, 28ms + Draw 2: after a1, 20ms + section Compute + Kernel: b1, 20, 12ms +``` ## Output in compact mode diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index cbe4bad6b0..12d9bf9eef 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -251,7 +251,7 @@ gantt weekday monday ``` -```warning +````warning `millisecond` and `second` support was added in v10.3.0 ### Changing Today (v\+) @@ -266,7 +266,7 @@ gantt section Section A task :a1, 2024-01-01, 30d Another task :after a1, 20d -``` +```` You can also use a duration: