Skip to content

Commit e7ee3eb

Browse files
Yokozuna59Yokozuna59
authored
Merge branch 'develop' into standardized-pie-definitions
2 parents 02daf54 + b85c011 commit e7ee3eb

File tree

7 files changed

+190
-295
lines changed

7 files changed

+190
-295
lines changed

‎docs/intro/index.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,12 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins
1414
1515
<img src="/header.png" alt="" />
1616

17+
<div class='badges'>
18+
1719
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
1820

21+
</div>
22+
1923
<!-- Mermaid book banner -->
2024

2125
[![Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!](img/book-banner-post-release.jpg)](https://mermaid-js.github.io/mermaid/landing/)
@@ -389,8 +393,12 @@ The above command generates files into the `dist` folder and publishes them to \
389393

390394
## Contributors
391395

396+
<div class='badges'>
397+
392398
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
393399

400+
</div>
401+
394402
Mermaid is a growing community and is always accepting new contributors. There's a lot of different ways to help out and we're always looking for extra hands! Look at [this issue](https://github.com/mermaid-js/mermaid/issues/866) if you want to know where to start helping out.
395403

396404
Detailed information about how to contribute can be found in the [contribution guide](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
@@ -424,20 +432,14 @@ A quick note from Knut Sveidqvist:
424432
_Mermaid was created by Knut Sveidqvist for easier documentation._
425433

426434
<style scoped>
427-
#contributors + p,
428-
#about-mermaid + p + p + blockquote + img + p
429-
{
430-
display: flex
435+
.badges > p {
436+
display: flex;
431437
}
432-
433-
#contributors + p a,
434-
#about-mermaid + p + p + blockquote + img + p a
435-
{
436-
margin: 0 0.5rem
438+
.badges > p > a {
439+
margin: 0 0.5rem;
437440
}
438441

439-
.dark #VPContent > div > div > div.content > div > main > div > div > img
440-
{
442+
.dark #VPContent > div > div > div.content > div > main > div > div > img {
441443
filter: invert(1) hue-rotate(217deg) contrast(0.72);
442444
}
443445
</style>

‎docs/syntax/flowchart.md

+42
Original file line numberDiff line numberDiff line change
@@ -748,6 +748,48 @@ flowchart LR
748748
B1 --> B2
749749
```
750750

751+
#### Limitation
752+
753+
If any of a subgraph's nodes are linked to the outside, subgraph direction will be ignored. Instead the subgraph will inherit the direction of the parent graph:
754+
755+
```mermaid-example
756+
flowchart LR
757+
subgraph subgraph1
758+
direction TB
759+
top1[top] --> bottom1[bottom]
760+
end
761+
subgraph subgraph2
762+
direction TB
763+
top2[top] --> bottom2[bottom]
764+
end
765+
%% ^ These subgraphs are identical, except for the links to them:
766+
767+
%% Link *to* subgraph1: subgraph1 direction is mantained
768+
outside --> subgraph1
769+
%% Link *within* subgraph2:
770+
%% subgraph2 inherits the direction of the top-level graph (LR)
771+
outside ---> top2
772+
```
773+
774+
```mermaid
775+
flowchart LR
776+
subgraph subgraph1
777+
direction TB
778+
top1[top] --> bottom1[bottom]
779+
end
780+
subgraph subgraph2
781+
direction TB
782+
top2[top] --> bottom2[bottom]
783+
end
784+
%% ^ These subgraphs are identical, except for the links to them:
785+
786+
%% Link *to* subgraph1: subgraph1 direction is mantained
787+
outside --> subgraph1
788+
%% Link *within* subgraph2:
789+
%% subgraph2 inherits the direction of the top-level graph (LR)
790+
outside ---> top2
791+
```
792+
751793
## Markdown Strings
752794

753795
The "Markdown Strings" feature enhances flowcharts and mind maps by offering a more versatile string type, which supports text formatting options such as bold and italics, and automatically wraps text within labels.

‎packages/mermaid/src/docs/.vitepress/config.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ function sidebarAll() {
101101
return [
102102
{
103103
text: '📔 Introduction',
104-
collapsible: true,
104+
collapsed: false,
105105
items: [
106106
{ text: 'About Mermaid', link: '/intro/' },
107107
{ text: 'Deployment', link: '/intro/n00b-gettingStarted' },
@@ -123,7 +123,7 @@ function sidebarSyntax() {
123123
return [
124124
{
125125
text: '📊 Diagram Syntax',
126-
collapsible: true,
126+
collapsed: false,
127127
items: [
128128
{ text: 'Flowchart', link: '/syntax/flowchart' },
129129
{ text: 'Sequence Diagram', link: '/syntax/sequenceDiagram' },
@@ -154,7 +154,7 @@ function sidebarConfig() {
154154
return [
155155
{
156156
text: '⚙️ Deployment and Configuration',
157-
collapsible: true,
157+
collapsed: false,
158158
items: [
159159
{ text: 'Configuration', link: '/config/configuration' },
160160
{ text: 'Tutorials', link: '/config/Tutorials' },
@@ -176,7 +176,7 @@ function sidebarEcosystem() {
176176
return [
177177
{
178178
text: '📚 Ecosystem',
179-
collapsible: true,
179+
collapsed: false,
180180
items: [
181181
{ text: 'Showcases', link: '/ecosystem/showcases' },
182182
{ text: 'Use-Cases and Integrations', link: '/ecosystem/integrations' },
@@ -189,7 +189,7 @@ function sidebarCommunity() {
189189
return [
190190
{
191191
text: '🙌 Contributions and Community',
192-
collapsible: true,
192+
collapsed: false,
193193
items: [
194194
{ text: 'Overview for Beginners', link: '/community/n00b-overview' },
195195
...sidebarCommunityDevelopContribute(),
@@ -207,7 +207,7 @@ function sidebarCommunityDevelopContribute() {
207207
{
208208
text: 'Contributing to Mermaid',
209209
link: page_path + '#contributing-to-mermaid',
210-
collapsible: true,
210+
collapsed: false,
211211
items: [
212212
{
213213
text: 'Technical Requirements and Setup',
@@ -238,7 +238,7 @@ function sidebarNews() {
238238
return [
239239
{
240240
text: '📰 Latest News',
241-
collapsible: true,
241+
collapsed: false,
242242
items: [
243243
{ text: 'Announcements', link: '/news/announcements' },
244244
{ text: 'Blog', link: '/news/blog' },

‎packages/mermaid/src/docs/intro/index.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,12 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins
88
99
<img src="/header.png" alt="" />
1010

11+
<div class='badges'>
12+
1113
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
1214

15+
</div>
16+
1317
<!-- Mermaid book banner -->
1418

1519
[![Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!](img/book-banner-post-release.jpg)](https://mermaid-js.github.io/mermaid/landing/)
@@ -166,8 +170,12 @@ The above command generates files into the `dist` folder and publishes them to <
166170

167171
## Contributors
168172

173+
<div class='badges'>
174+
169175
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
170176

177+
</div>
178+
171179
Mermaid is a growing community and is always accepting new contributors. There's a lot of different ways to help out and we're always looking for extra hands! Look at [this issue](https://github.com/mermaid-js/mermaid/issues/866) if you want to know where to start helping out.
172180

173181
Detailed information about how to contribute can be found in the [contribution guide](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
@@ -201,20 +209,14 @@ A quick note from Knut Sveidqvist:
201209
_Mermaid was created by Knut Sveidqvist for easier documentation._
202210

203211
<style scoped>
204-
#contributors + p,
205-
#about-mermaid + p + p + blockquote + img + p
206-
{
207-
display: flex
212+
.badges > p {
213+
display: flex;
208214
}
209-
210-
#contributors + p a,
211-
#about-mermaid + p + p + blockquote + img + p a
212-
{
213-
margin: 0 0.5rem
215+
.badges > p > a {
216+
margin: 0 0.5rem;
214217
}
215218

216-
.dark #VPContent > div > div > div.content > div > main > div > div > img
217-
{
219+
.dark #VPContent > div > div > div.content > div > main > div > div > img {
218220
filter: invert(1) hue-rotate(217deg) contrast(0.72);
219221
}
220222
</style>

‎packages/mermaid/src/docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"dependencies": {
1818
"@vueuse/core": "^10.1.0",
1919
"jiti": "^1.18.2",
20-
"vue": "^3.2.47"
20+
"vue": "^3.3"
2121
},
2222
"devDependencies": {
2323
"@iconify-json/carbon": "^1.1.16",

‎packages/mermaid/src/docs/syntax/flowchart.md

+23
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,29 @@ flowchart LR
471471
B1 --> B2
472472
```
473473

474+
#### Limitation
475+
476+
If any of a subgraph's nodes are linked to the outside, subgraph direction will be ignored. Instead the subgraph will inherit the direction of the parent graph:
477+
478+
```mermaid-example
479+
flowchart LR
480+
subgraph subgraph1
481+
direction TB
482+
top1[top] --> bottom1[bottom]
483+
end
484+
subgraph subgraph2
485+
direction TB
486+
top2[top] --> bottom2[bottom]
487+
end
488+
%% ^ These subgraphs are identical, except for the links to them:
489+
490+
%% Link *to* subgraph1: subgraph1 direction is mantained
491+
outside --> subgraph1
492+
%% Link *within* subgraph2:
493+
%% subgraph2 inherits the direction of the top-level graph (LR)
494+
outside ---> top2
495+
```
496+
474497
## Markdown Strings
475498

476499
The "Markdown Strings" feature enhances flowcharts and mind maps by offering a more versatile string type, which supports text formatting options such as bold and italics, and automatically wraps text within labels.

0 commit comments

Comments
 (0)