Skip to content

Commit

Permalink
(Re)add documentation in the right place
Browse files Browse the repository at this point in the history
  • Loading branch information
bprb committed Aug 9, 2024
1 parent 9943c93 commit f1cbd79
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions packages/mermaid/src/docs/syntax/gantt.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,38 @@ gantt

```warning
`millisecond` and `second` support was added in v10.3.0
### Changing Today (v\<MERMAID_RELEASE_VERSION>+)
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
```

## Output in compact mode
Expand Down

0 comments on commit f1cbd79

Please sign in to comment.