marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-08-30 05:36:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

stripping comments from gantt example

Browse Source 
as requested, I've pulled comments onto the main syntax pages, so stripping many of the comments from here
This commit is contained in:
generrosity
2025-04-19 20:07:12 +12:00
committed by GitHub
parent 8d7330aeb3
commit f8c6ae5d17
1 changed files with 1 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
packages/mermaid/src/docs/syntax/gantt.md
View File

@@ -475,19 +475,13 @@ gantt
```mermaid-example ```mermaid-example
--- ---
# 'Triple dash' MUST be first to start mermaid frontmatter. # Frontmatter config, YAML comments
# 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 title: Ignored if specified in chart
displayMode: compact #gantt specific setting but works at this level too displayMode: compact #gantt specific setting but works at this level too
config: config:
# yaml style comment
# theme: forest # theme: forest
# themeCSS: " #item36 { fill: CadetBlue } " # themeCSS: " #item36 { fill: CadetBlue } "
themeCSS: " // YAML supports multiline strings using a newline markers: \n themeCSS: " // YAML supports multiline strings using a newline markers: \n
// Comment in CSS using slashes \n
#item36 { fill: CadetBlue } \n #item36 { fill: CadetBlue } \n
// Custom marker workaround CSS from forum (below) \n // Custom marker workaround CSS from forum (below) \n
@@ -500,11 +494,6 @@ gantt
topAxis: true #false topAxis: true #false
numberSectionStyles: 2 numberSectionStyles: 2
--- ---
%% 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 gantt
title Timeline - Gantt Sampler title Timeline - Gantt Sampler
dateFormat YYYY dateFormat YYYY