diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index eab35d09f..8121fe4a2 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -471,4 +471,45 @@ gantt 5 : 0, 5 ``` + +### Timeline (with comments, CSS, settings, and Obsidian-style preprocessor) + +```mermaid-example +--- + # triple line MUST be first. yaml comment. + displayMode: compact +--- +%%{ + init: { + 'themeCSS': ' #item36 { fill: CadetBlue } ', + 'Comment': 'Not official, but common in JSON', + 'themeCSS': ' rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } text[id^=workaround] { fill: red; y: 100%; font-size: 15px;}', + 'gantt':{ + 'useWidth': 400, 'rightPadding': 0 + } + } +}%% +gantt + title Sampler + dateFormat YYYY + axisFormat %y + %% comment - this next line doesn't recognise year + tickInterval 4year + + + section Issue19062 + 71 : item71, 1900, 1930 + section Issue19401 + 36 : item36, 1913, 1935 + section Issue1300 + 94 : item94, 1910, 1915 + 5 : item5, 1920, 1925 + 0 : milestone, item0, 1918, 1s + 9 : vert, 1906, 1s %% not yet official + 64 : workaround, 1923, 1s %% custom CSS object https://github.com/mermaid-js/mermaid/issues/3250 +``` + + + +