diff --git a/docs/community/contributing.md b/docs/community/contributing.md index ce010b316..ef6bef987 100644 --- a/docs/community/contributing.md +++ b/docs/community/contributing.md @@ -29,7 +29,8 @@ In GitHub, you first [**fork a mermaid repository**](https://github.com/mermaid- Then you **clone** a copy to your local development machine (e.g. where you code) to make a copy with all the files to work with. -> **💡 Tip** > [Here is a GitHub document that gives an overview of the process](https://docs.github.com/en/get-started/quickstart/fork-a-repo). +> **💡 Tip** +> [Here is a GitHub document that gives an overview of the process](https://docs.github.com/en/get-started/quickstart/fork-a-repo). ```bash git clone git@github.com/your-fork/mermaid diff --git a/docs/community/intro.md b/docs/community/intro.md index 6b1430572..a549d031e 100644 --- a/docs/community/intro.md +++ b/docs/community/intro.md @@ -33,7 +33,8 @@ mindmap ## Join the Development -> **💡 Tip** > **Check out our** [**detailed contribution guide**](./contributing.md). +> **💡 Tip** +> **Check out our** [**detailed contribution guide**](./contributing.md). Where to start: @@ -47,7 +48,8 @@ Where to start: ## A Question Or a Suggestion? -> **💡 Tip** > **Have a look at** [**how to open an issue**](./questions-and-suggestions.md). +> **💡 Tip** +> **Have a look at** [**how to open an issue**](./questions-and-suggestions.md). If you have faced a vulnerability [report it to us](./security.md). diff --git a/docs/config/directives.md b/docs/config/directives.md index 13a663133..40ebd81a4 100644 --- a/docs/config/directives.md +++ b/docs/config/directives.md @@ -22,7 +22,6 @@ While directives allow you to change most of the default configuration settings, Mermaid basically supports two types of configuration options to be overridden by directives. 1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are: - - theme - fontFamily - logLevel diff --git a/docs/ecosystem/mermaid-chart.md b/docs/ecosystem/mermaid-chart.md index 8100a1846..fd1e70aca 100644 --- a/docs/ecosystem/mermaid-chart.md +++ b/docs/ecosystem/mermaid-chart.md @@ -29,7 +29,6 @@ Try the Ultimate AI, Mermaid, and Visual Diagramming Suite by creating an accoun - **Plugins** - A plugin system for extending the functionality of Mermaid. Official Mermaid Chart plugins: - - [Mermaid Chart GPT](https://chatgpt.com/g/g-684cc36f30208191b21383b88650a45d-mermaid-chart-diagrams-and-charts) - [Confluence](https://marketplace.atlassian.com/apps/1234056/mermaid-chart-for-confluence?hosting=cloud&tab=overview) - [Jira](https://marketplace.atlassian.com/apps/1234810/mermaid-chart-for-jira?tab=overview&hosting=cloud) diff --git a/docs/news/announcements.md b/docs/news/announcements.md index a8a67343d..e054d2da0 100644 --- a/docs/news/announcements.md +++ b/docs/news/announcements.md @@ -35,13 +35,11 @@ The Mermaid Chart team is excited to introduce a new Visual Editor for Flowchart Learn more: - Visual Editor For Flowcharts - - [Blog post](https://www.mermaidchart.com/blog/posts/mermaid-chart-releases-new-visual-editor-for-flowcharts) - [Demo video](https://www.youtube.com/watch?v=5aja0gijoO0) - Visual Editor For Sequence diagrams - - [Blog post](https://www.mermaidchart.com/blog/posts/mermaid-chart-unveils-visual-editor-for-sequence-diagrams) - [Demo video](https://youtu.be/imc2u5_N6Dc) diff --git a/docs/syntax/c4.md b/docs/syntax/c4.md index c1d2e1597..ae610d152 100644 --- a/docs/syntax/c4.md +++ b/docs/syntax/c4.md @@ -139,7 +139,6 @@ The following unfinished features are not supported in the short term. - [ ] Legend - [x] System Context - - [x] Person(alias, label, ?descr, ?sprite, ?tags, $link) - [x] Person_Ext - [x] System(alias, label, ?descr, ?sprite, ?tags, $link) @@ -153,7 +152,6 @@ The following unfinished features are not supported in the short term. - [x] System_Boundary - [x] Container diagram - - [x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - [x] ContainerDb - [x] ContainerQueue @@ -163,7 +161,6 @@ The following unfinished features are not supported in the short term. - [x] Container_Boundary(alias, label, ?tags, $link) - [x] Component diagram - - [x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - [x] ComponentDb - [x] ComponentQueue @@ -172,18 +169,15 @@ The following unfinished features are not supported in the short term. - [x] ComponentQueue_Ext - [x] Dynamic diagram - - [x] RelIndex(index, from, to, label, ?tags, $link) - [x] Deployment diagram - - [x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link) - [x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node() - [x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node() - [x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node() - [x] Relationship Types - - [x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link) - [x] BiRel (bidirectional relationship) - [x] Rel_U, Rel_Up diff --git a/docs/syntax/gantt.md b/docs/syntax/gantt.md index 552c1658a..3a42f04e1 100644 --- a/docs/syntax/gantt.md +++ b/docs/syntax/gantt.md @@ -360,7 +360,8 @@ gantt weekday monday ``` -> **Warning** > `millisecond` and `second` support was added in v10.3.0 +> **Warning** +> `millisecond` and `second` support was added in v10.3.0 ## Output in compact mode diff --git a/packages/mermaid/CHANGELOG.md b/packages/mermaid/CHANGELOG.md index fc2f97fdf..cc706c799 100644 --- a/packages/mermaid/CHANGELOG.md +++ b/packages/mermaid/CHANGELOG.md @@ -154,7 +154,6 @@ ### Minor Changes - [#6408](https://github.com/mermaid-js/mermaid/pull/6408) [`ad65313`](https://github.com/mermaid-js/mermaid/commit/ad653138e16765d095613a6e5de86dc5e52ac8f0) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - fix: restore curve type configuration functionality for flowcharts. This fixes the issue where curve type settings were not being applied when configured through any of the following methods: - - Config - Init directive (%%{ init: { 'flowchart': { 'curve': '...' } } }%%) - LinkStyle command (linkStyle default interpolate ...) @@ -173,14 +172,12 @@ ### Minor Changes - [#6187](https://github.com/mermaid-js/mermaid/pull/6187) [`7809b5a`](https://github.com/mermaid-js/mermaid/commit/7809b5a93fae127f45727071f5ff14325222c518) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - Flowchart new syntax for node metadata bugs - - Incorrect label mapping for nodes when using `&` - Syntax error when `}` with trailing spaces before new line - [#6136](https://github.com/mermaid-js/mermaid/pull/6136) [`ec0d9c3`](https://github.com/mermaid-js/mermaid/commit/ec0d9c389aa6018043187654044c1e0b5aa4f600) Thanks [@knsv](https://github.com/knsv)! - Adding support for animation of flowchart edges - [#6373](https://github.com/mermaid-js/mermaid/pull/6373) [`05bdf0e`](https://github.com/mermaid-js/mermaid/commit/05bdf0e20e2629fe77513218fbd4e28e65f75882) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - Upgrade Requirement and ER diagram to use the common renderer flow - - Added support for directions - Added support for hand drawn look diff --git a/packages/mermaid/src/docs/config/directives.md b/packages/mermaid/src/docs/config/directives.md index 017fc486b..668c07c7a 100644 --- a/packages/mermaid/src/docs/config/directives.md +++ b/packages/mermaid/src/docs/config/directives.md @@ -17,7 +17,6 @@ While directives allow you to change most of the default configuration settings, Mermaid basically supports two types of configuration options to be overridden by directives. 1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are: - - theme - fontFamily - logLevel diff --git a/packages/mermaid/src/docs/ecosystem/mermaid-chart.md b/packages/mermaid/src/docs/ecosystem/mermaid-chart.md index 58598adce..0d6e88f77 100644 --- a/packages/mermaid/src/docs/ecosystem/mermaid-chart.md +++ b/packages/mermaid/src/docs/ecosystem/mermaid-chart.md @@ -23,7 +23,6 @@ Try the Ultimate AI, Mermaid, and Visual Diagramming Suite by creating an accoun - **Plugins** - A plugin system for extending the functionality of Mermaid. Official Mermaid Chart plugins: - - [Mermaid Chart GPT](https://chatgpt.com/g/g-684cc36f30208191b21383b88650a45d-mermaid-chart-diagrams-and-charts) - [Confluence](https://marketplace.atlassian.com/apps/1234056/mermaid-chart-for-confluence?hosting=cloud&tab=overview) - [Jira](https://marketplace.atlassian.com/apps/1234810/mermaid-chart-for-jira?tab=overview&hosting=cloud) diff --git a/packages/mermaid/src/docs/news/announcements.md b/packages/mermaid/src/docs/news/announcements.md index 6323c0f7d..03ee8ca94 100644 --- a/packages/mermaid/src/docs/news/announcements.md +++ b/packages/mermaid/src/docs/news/announcements.md @@ -33,13 +33,11 @@ The Mermaid Chart team is excited to introduce a new Visual Editor for Flowchart Learn more: - Visual Editor For Flowcharts - - [Blog post](https://www.mermaidchart.com/blog/posts/mermaid-chart-releases-new-visual-editor-for-flowcharts) - [Demo video](https://www.youtube.com/watch?v=5aja0gijoO0) - Visual Editor For Sequence diagrams - - [Blog post](https://www.mermaidchart.com/blog/posts/mermaid-chart-unveils-visual-editor-for-sequence-diagrams) - [Demo video](https://youtu.be/imc2u5_N6Dc) diff --git a/packages/mermaid/src/docs/syntax/c4.md b/packages/mermaid/src/docs/syntax/c4.md index c9b7eb6ad..5def257f4 100644 --- a/packages/mermaid/src/docs/syntax/c4.md +++ b/packages/mermaid/src/docs/syntax/c4.md @@ -83,7 +83,6 @@ The following unfinished features are not supported in the short term. - [ ] Legend - [x] System Context - - [x] Person(alias, label, ?descr, ?sprite, ?tags, $link) - [x] Person_Ext - [x] System(alias, label, ?descr, ?sprite, ?tags, $link) @@ -97,7 +96,6 @@ The following unfinished features are not supported in the short term. - [x] System_Boundary - [x] Container diagram - - [x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - [x] ContainerDb - [x] ContainerQueue @@ -107,7 +105,6 @@ The following unfinished features are not supported in the short term. - [x] Container_Boundary(alias, label, ?tags, $link) - [x] Component diagram - - [x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - [x] ComponentDb - [x] ComponentQueue @@ -116,18 +113,15 @@ The following unfinished features are not supported in the short term. - [x] ComponentQueue_Ext - [x] Dynamic diagram - - [x] RelIndex(index, from, to, label, ?tags, $link) - [x] Deployment diagram - - [x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link) - [x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node() - [x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node() - [x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node() - [x] Relationship Types - - [x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link) - [x] BiRel (bidirectional relationship) - [x] Rel_U, Rel_Up diff --git a/packages/parser/README.md b/packages/parser/README.md index 07ef5a5b4..763ffc7ed 100644 --- a/packages/parser/README.md +++ b/packages/parser/README.md @@ -44,18 +44,15 @@ ValueConverter -->> Package: Return AST ``` - When to override `TokenBuilder`? - - To override keyword rules. - To override terminal rules that need a custom function. - To manually reorder the list of rules. - When to override `Lexer`? - - To modify input before tokenizing. - To insert/modify tokens that cannot or have not been parsed. - When to override `LangiumParser`? - - To insert or modify attributes that can't be parsed. - When to override `ValueConverter`? diff --git a/packages/tiny/CHANGELOG.md b/packages/tiny/CHANGELOG.md index fc2f97fdf..cc706c799 100644 --- a/packages/tiny/CHANGELOG.md +++ b/packages/tiny/CHANGELOG.md @@ -154,7 +154,6 @@ ### Minor Changes - [#6408](https://github.com/mermaid-js/mermaid/pull/6408) [`ad65313`](https://github.com/mermaid-js/mermaid/commit/ad653138e16765d095613a6e5de86dc5e52ac8f0) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - fix: restore curve type configuration functionality for flowcharts. This fixes the issue where curve type settings were not being applied when configured through any of the following methods: - - Config - Init directive (%%{ init: { 'flowchart': { 'curve': '...' } } }%%) - LinkStyle command (linkStyle default interpolate ...) @@ -173,14 +172,12 @@ ### Minor Changes - [#6187](https://github.com/mermaid-js/mermaid/pull/6187) [`7809b5a`](https://github.com/mermaid-js/mermaid/commit/7809b5a93fae127f45727071f5ff14325222c518) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - Flowchart new syntax for node metadata bugs - - Incorrect label mapping for nodes when using `&` - Syntax error when `}` with trailing spaces before new line - [#6136](https://github.com/mermaid-js/mermaid/pull/6136) [`ec0d9c3`](https://github.com/mermaid-js/mermaid/commit/ec0d9c389aa6018043187654044c1e0b5aa4f600) Thanks [@knsv](https://github.com/knsv)! - Adding support for animation of flowchart edges - [#6373](https://github.com/mermaid-js/mermaid/pull/6373) [`05bdf0e`](https://github.com/mermaid-js/mermaid/commit/05bdf0e20e2629fe77513218fbd4e28e65f75882) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - Upgrade Requirement and ER diagram to use the common renderer flow - - Added support for directions - Added support for hand drawn look