From e425a45755a086606a3954a47c3675cc8d663695 Mon Sep 17 00:00:00 2001 From: generrosity Date: Wed, 16 Apr 2025 21:15:14 +1200 Subject: [PATCH 01/15] extra sample gantt chart with extras --- packages/mermaid/src/docs/syntax/gantt.md | 41 +++++++++++++++++++++++ 1 file changed, 41 insertions(+) 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 +``` + + + + From 63b90e8b9baec004e198b0da04405c0add4af4b8 Mon Sep 17 00:00:00 2001 From: generrosity Date: Thu, 17 Apr 2025 22:23:21 +1200 Subject: [PATCH 02/15] tweaks adding some of the correct terms and references, depreciation --- packages/mermaid/src/docs/syntax/gantt.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index 8121fe4a2..654559e81 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -472,20 +472,27 @@ gantt ``` -### Timeline (with comments, CSS, settings, and Obsidian-style preprocessor) +### Timeline (with comments, CSS, config in frontmatter, directives) ```mermaid-example --- - # triple line MUST be first. yaml comment. + # triple line MUST be first to start frontmatter. Then, any consistent indent + # yaml style comment displayMode: compact + config: +# theme: forest +# themeCSS: " #item36 { fill: CadetBlue } " + gantt: + useWidth: 400 + --- %%{ 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;}', + 'Comment': 'Not official, but common JSON style comment', + 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', + 'themeCSS': ' #item36 { fill: CadetBlue } 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 + 'usedWidth': 400, 'rightPadding': 0 } } }%% @@ -500,13 +507,13 @@ gantt section Issue19062 71 : item71, 1900, 1930 section Issue19401 - 36 : item36, 1913, 1935 + 36 : item36, 1913, 1935 %% themeCSS targets #item36 as id directly 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 + 64 : workaround, 1923, 1s %% custom CSS object in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 ``` From ceef0558be23ecdc02f917f3578cce3bbe7df809 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Thu, 17 Apr 2025 10:44:26 +0000 Subject: [PATCH 03/15] [autofix.ci] apply automated fixes --- docs/syntax/gantt.md | 86 +++++++++++++++++++++++ packages/mermaid/src/docs/syntax/gantt.md | 14 ++-- 2 files changed, 91 insertions(+), 9 deletions(-) diff --git a/docs/syntax/gantt.md b/docs/syntax/gantt.md index ff6be97aa..0f4d62cb8 100644 --- a/docs/syntax/gantt.md +++ b/docs/syntax/gantt.md @@ -598,4 +598,90 @@ gantt 5 : 0, 5 ``` +### Timeline (with comments, CSS, config in frontmatter, directives) + +```mermaid-example +--- + # triple line MUST be first to start frontmatter. Then, any consistent indent + # yaml style comment + displayMode: compact + config: +# theme: forest +# themeCSS: " #item36 { fill: CadetBlue } " + gantt: + useWidth: 400 + +--- +%%{ + init: { + 'Comment': 'Not official, but common JSON style comment', + 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', + 'themeCSS': ' #item36 { fill: CadetBlue } 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':{ + 'usedWidth': 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 %% themeCSS targets #item36 as id directly + 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 in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 +``` + +```mermaid +--- + # triple line MUST be first to start frontmatter. Then, any consistent indent + # yaml style comment + displayMode: compact + config: +# theme: forest +# themeCSS: " #item36 { fill: CadetBlue } " + gantt: + useWidth: 400 + +--- +%%{ + init: { + 'Comment': 'Not official, but common JSON style comment', + 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', + 'themeCSS': ' #item36 { fill: CadetBlue } 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':{ + 'usedWidth': 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 %% themeCSS targets #item36 as id directly + 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 in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 +``` + diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index 654559e81..59ba06af6 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -471,7 +471,6 @@ gantt 5 : 0, 5 ``` - ### Timeline (with comments, CSS, config in frontmatter, directives) ```mermaid-example @@ -487,14 +486,14 @@ gantt --- %%{ - init: { + init: { 'Comment': 'Not official, but common JSON style comment', 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', 'themeCSS': ' #item36 { fill: CadetBlue } 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':{ + 'gantt':{ 'usedWidth': 400, 'rightPadding': 0 } - } + } }%% gantt title Sampler @@ -502,12 +501,12 @@ gantt axisFormat %y %% comment - this next line doesn't recognise year tickInterval 4year - + section Issue19062 71 : item71, 1900, 1930 section Issue19401 - 36 : item36, 1913, 1935 %% themeCSS targets #item36 as id directly + 36 : item36, 1913, 1935 %% themeCSS targets #item36 as id directly section Issue1300 94 : item94, 1910, 1915 5 : item5, 1920, 1925 @@ -516,7 +515,4 @@ gantt 64 : workaround, 1923, 1s %% custom CSS object in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 ``` - - - From beb80db25ab63a034e483b3798b8a9c13fdaf7f6 Mon Sep 17 00:00:00 2001 From: generrosity Date: Fri, 18 Apr 2025 15:37:50 +1200 Subject: [PATCH 04/15] shift directives to frontmatter * shifting directives to frontmatter as recomended - it is literally about to me removed, * tweaking context comment about directives * tweaking code in general formatting, spelling, wording --- packages/mermaid/src/docs/syntax/gantt.md | 57 +++++++++++++---------- 1 file changed, 33 insertions(+), 24 deletions(-) diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index 2c2ecf8d4..4cdacbecf 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -471,48 +471,57 @@ gantt 5 : 0, 5 ``` -### Timeline (with comments, CSS, config in frontmatter, directives) +### Timeline (with comments, CSS, config in frontmatter) ```mermaid-example --- - # triple line MUST be first to start frontmatter. Then, any consistent indent - # yaml style comment - displayMode: compact + # 'Triple dash' MUST be first to start mermaid frontmatter. + # YAML requires consistent indenting + # Settings are caseSensitive, silently ignore mispellings; incorrect parameters will break diagram, and inconsistantly require strings to be quoted + # Reminder to test diagrams online: https://mermaid.live + # 'init' and chart 'config' settings belong here. + title: Ignored if specified in chart + displayMode: compact #gantt specific setting but works at this level too config: + # yaml style comment # theme: forest # themeCSS: " #item36 { fill: CadetBlue } " + themeCSS: " // YAML supports multiline strings using a newline markers: \n + // Comment in CSS using slashes \n + #item36 { fill: CadetBlue } \n + + // Custom marker workaround CSS from forum (below) \n + rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } \n + text[id^=workaround] { fill: red; y: 100%; font-size: 15px;} + " gantt: useWidth: 400 - + rightPadding: 0 + topAxis: true #false + numberSectionStyles: 2 --- -%%{ - init: { - 'Comment': 'Not official, but common JSON style comment', - 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', - 'themeCSS': ' #item36 { fill: CadetBlue } 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':{ - 'usedWidth': 400, 'rightPadding': 0 - } - } -}%% +%% nb: As of 2025, using directives "%%{" here for 'init' not longer supported - use frontmatter (triple-dash) instead. + +%% Comment for Mermaid (double percent + at least a space) +%% Script is case insensitive. Indents are completely ignored. +%% Mispelling or unknown words will break diagrams, while parameters silently fail. Strings shouldn't be quoted and will auto-detect based on expected parameters gantt - title Sampler - dateFormat YYYY + title Timeline - Gantt Sampler + dateFormat YYYY axisFormat %y - %% comment - this next line doesn't recognise year - tickInterval 4year - - + %% this next line doesn't recognise 'decade' or 'year', but will silently ignore + tickInterval 1decade + section Issue19062 71 : item71, 1900, 1930 section Issue19401 - 36 : item36, 1913, 1935 %% themeCSS targets #item36 as id directly + 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 in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 + 9 : vert, 1906, 1s %% not yet official + 64 : workaround, 1923, 1s %% custom CSS object https://github.com/mermaid-js/mermaid/issues/3250 ``` From 054f5444d649a0942aa6e2b4ff252893eef44812 Mon Sep 17 00:00:00 2001 From: generrosity Date: Fri, 18 Apr 2025 15:48:08 +1200 Subject: [PATCH 05/15] spellchecked inconsistently misspelling inconsistently misspelling --- packages/mermaid/src/docs/syntax/gantt.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index 4cdacbecf..ab5e2d431 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -477,7 +477,7 @@ gantt --- # 'Triple dash' MUST be first to start mermaid frontmatter. # YAML requires consistent indenting - # Settings are caseSensitive, silently ignore mispellings; incorrect parameters will break diagram, and inconsistantly require strings to be quoted + # Settings are caseSensitive, silently ignore misspellings; incorrect parameters will break diagram, and inconsistently require strings to be quoted # Reminder to test diagrams online: https://mermaid.live # 'init' and chart 'config' settings belong here. title: Ignored if specified in chart @@ -504,7 +504,7 @@ gantt %% Comment for Mermaid (double percent + at least a space) %% Script is case insensitive. Indents are completely ignored. -%% Mispelling or unknown words will break diagrams, while parameters silently fail. Strings shouldn't be quoted and will auto-detect based on expected parameters +%% misspelling or unknown words will break diagrams, while parameters silently fail. Strings shouldn't be quoted and will auto-detect based on expected parameters gantt title Timeline - Gantt Sampler dateFormat YYYY From 79b47be35f283af4dc1c540038a55d72f8184171 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Fri, 18 Apr 2025 03:52:33 +0000 Subject: [PATCH 06/15] [autofix.ci] apply automated fixes --- docs/syntax/gantt.md | 104 +++++++++++++--------- packages/mermaid/src/docs/syntax/gantt.md | 14 +-- 2 files changed, 68 insertions(+), 50 deletions(-) diff --git a/docs/syntax/gantt.md b/docs/syntax/gantt.md index 0f4d62cb8..d9a79dae6 100644 --- a/docs/syntax/gantt.md +++ b/docs/syntax/gantt.md @@ -598,90 +598,108 @@ gantt 5 : 0, 5 ``` -### Timeline (with comments, CSS, config in frontmatter, directives) +### Timeline (with comments, CSS, config in frontmatter) ```mermaid-example --- - # triple line MUST be first to start frontmatter. Then, any consistent indent - # yaml style comment - displayMode: compact + # 'Triple dash' MUST be first to start mermaid frontmatter. + # YAML requires consistent indenting + # Settings are caseSensitive, silently ignore misspellings; incorrect parameters will break diagram, and inconsistently require strings to be quoted + # Reminder to test diagrams online: https://mermaid.live + # 'init' and chart 'config' settings belong here. + title: Ignored if specified in chart + displayMode: compact #gantt specific setting but works at this level too config: + # yaml style comment # theme: forest # themeCSS: " #item36 { fill: CadetBlue } " + themeCSS: " // YAML supports multiline strings using a newline markers: \n + // Comment in CSS using slashes \n + #item36 { fill: CadetBlue } \n + + // Custom marker workaround CSS from forum (below) \n + rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } \n + text[id^=workaround] { fill: red; y: 100%; font-size: 15px;} + " gantt: useWidth: 400 - + rightPadding: 0 + topAxis: true #false + numberSectionStyles: 2 --- -%%{ - init: { - 'Comment': 'Not official, but common JSON style comment', - 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', - 'themeCSS': ' #item36 { fill: CadetBlue } 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':{ - 'usedWidth': 400, 'rightPadding': 0 - } - } -}%% +%% nb: As of 2025, using directives "%%{" here for 'init' not longer supported - use frontmatter (triple-dash) instead. + +%% Comment for Mermaid (double percent + at least a space) +%% Script is case insensitive. Indents are completely ignored. +%% misspelling or unknown words will break diagrams, while parameters silently fail. Strings shouldn't be quoted and will auto-detect based on expected parameters gantt - title Sampler + title Timeline - Gantt Sampler dateFormat YYYY axisFormat %y - %% comment - this next line doesn't recognise year - tickInterval 4year - + %% this next line doesn't recognise 'decade' or 'year', but will silently ignore + tickInterval 1decade section Issue19062 71 : item71, 1900, 1930 section Issue19401 - 36 : item36, 1913, 1935 %% themeCSS targets #item36 as id directly + 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 in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 + 9 : vert, 1906, 1s %% not yet official + 64 : workaround, 1923, 1s %% custom CSS object https://github.com/mermaid-js/mermaid/issues/3250 ``` ```mermaid --- - # triple line MUST be first to start frontmatter. Then, any consistent indent - # yaml style comment - displayMode: compact + # 'Triple dash' MUST be first to start mermaid frontmatter. + # YAML requires consistent indenting + # Settings are caseSensitive, silently ignore misspellings; incorrect parameters will break diagram, and inconsistently require strings to be quoted + # Reminder to test diagrams online: https://mermaid.live + # 'init' and chart 'config' settings belong here. + title: Ignored if specified in chart + displayMode: compact #gantt specific setting but works at this level too config: + # yaml style comment # theme: forest # themeCSS: " #item36 { fill: CadetBlue } " + themeCSS: " // YAML supports multiline strings using a newline markers: \n + // Comment in CSS using slashes \n + #item36 { fill: CadetBlue } \n + + // Custom marker workaround CSS from forum (below) \n + rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } \n + text[id^=workaround] { fill: red; y: 100%; font-size: 15px;} + " gantt: useWidth: 400 - + rightPadding: 0 + topAxis: true #false + numberSectionStyles: 2 --- -%%{ - init: { - 'Comment': 'Not official, but common JSON style comment', - 'Comment': 'Depreciated 2023 for frontmatter, easier to format, overrides frontmatter', - 'themeCSS': ' #item36 { fill: CadetBlue } 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':{ - 'usedWidth': 400, 'rightPadding': 0 - } - } -}%% +%% nb: As of 2025, using directives "%%{" here for 'init' not longer supported - use frontmatter (triple-dash) instead. + +%% Comment for Mermaid (double percent + at least a space) +%% Script is case insensitive. Indents are completely ignored. +%% misspelling or unknown words will break diagrams, while parameters silently fail. Strings shouldn't be quoted and will auto-detect based on expected parameters gantt - title Sampler + title Timeline - Gantt Sampler dateFormat YYYY axisFormat %y - %% comment - this next line doesn't recognise year - tickInterval 4year - + %% this next line doesn't recognise 'decade' or 'year', but will silently ignore + tickInterval 1decade section Issue19062 71 : item71, 1900, 1930 section Issue19401 - 36 : item36, 1913, 1935 %% themeCSS targets #item36 as id directly + 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 in themeCSS https://github.com/mermaid-js/mermaid/issues/3250 + 9 : vert, 1906, 1s %% not yet official + 64 : workaround, 1923, 1s %% custom CSS object https://github.com/mermaid-js/mermaid/issues/3250 ``` diff --git a/packages/mermaid/src/docs/syntax/gantt.md b/packages/mermaid/src/docs/syntax/gantt.md index ab5e2d431..45af4e6b2 100644 --- a/packages/mermaid/src/docs/syntax/gantt.md +++ b/packages/mermaid/src/docs/syntax/gantt.md @@ -475,7 +475,7 @@ gantt ```mermaid-example --- - # 'Triple dash' MUST be first to start mermaid frontmatter. + # 'Triple dash' MUST be first to start mermaid frontmatter. # YAML requires consistent indenting # Settings are caseSensitive, silently ignore misspellings; incorrect parameters will break diagram, and inconsistently require strings to be quoted # Reminder to test diagrams online: https://mermaid.live @@ -489,16 +489,16 @@ gantt themeCSS: " // YAML supports multiline strings using a newline markers: \n // Comment in CSS using slashes \n #item36 { fill: CadetBlue } \n - + // Custom marker workaround CSS from forum (below) \n rect[id^=workaround] { height: calc(100% - 50px) ; transform: translate(9px, 25px); y: 0; width: 1.5px; stroke: none; fill: red; } \n - text[id^=workaround] { fill: red; y: 100%; font-size: 15px;} + text[id^=workaround] { fill: red; y: 100%; font-size: 15px;} " gantt: useWidth: 400 rightPadding: 0 topAxis: true #false - numberSectionStyles: 2 + numberSectionStyles: 2 --- %% nb: As of 2025, using directives "%%{" here for 'init' not longer supported - use frontmatter (triple-dash) instead. @@ -506,12 +506,12 @@ gantt %% Script is case insensitive. Indents are completely ignored. %% misspelling or unknown words will break diagrams, while parameters silently fail. Strings shouldn't be quoted and will auto-detect based on expected parameters gantt - title Timeline - Gantt Sampler - dateFormat YYYY + title Timeline - Gantt Sampler + dateFormat YYYY axisFormat %y %% this next line doesn't recognise 'decade' or 'year', but will silently ignore tickInterval 1decade - + section Issue19062 71 : item71, 1900, 1930 section Issue19401 From 6a6c9f6254db3aa68050642e59ec62aca19c6842 Mon Sep 17 00:00:00 2001 From: generrosity Date: Sat, 19 Apr 2025 19:38:14 +1200 Subject: [PATCH 07/15] Add Frontmatteer to syntax more explicitly --- .../src/docs/intro/syntax-reference.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/packages/mermaid/src/docs/intro/syntax-reference.md b/packages/mermaid/src/docs/intro/syntax-reference.md index b439c26bc..42a02fe4c 100644 --- a/packages/mermaid/src/docs/intro/syntax-reference.md +++ b/packages/mermaid/src/docs/intro/syntax-reference.md @@ -54,12 +54,38 @@ The following are the most commonly used methods, and they are all tied to Merma Here you can edit certain values to change the behavior and appearance of the diagram. +Each of these techniques are functionally equivilent, but better for different deployments. + ### [The initialize() call](./getting-started.md#_3-calling-the-javascript-api) Used when Mermaid is called via an API, or through a `