Skip to content

Conversation

Actpohomoc
Copy link

📑 Summary

This pull request updates the flowchart.md documentation to clarify how to insert line breaks within text in flowchart nodes. Previously, the example showed multiple lines without explicitly demonstrating the mechanism for line breaks, which could be confusing for users.

The change replaces the ambiguous example:

flowchart TD
    newLines["`Line1
    Line 2
    Line 3`"]

with an explicit example using <br/> for a line break:

flowchart TD
    newLines["`Line1
    Line 2<br/>Line 3`"]

This simple addition directly addresses a common user difficulty in finding information about line breaks within flowchart text.

📏 Design Decisions

The primary design decision was to provide a clear and immediate answer to how line breaks are handled within flowchart text. Using <br/> is the standard HTML line break tag and is widely understood, making it the most intuitive solution for documentation. By directly showing this in the example, users can quickly grasp the concept without needing to search for additional notes or documentation sections.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

it was shown two times same thing:
    newLines["`Line1
    Line 2
    Line 3`"]
I propose include simple extra important information about line breaks:
    newLines["`Line1
    Line 2<br/>Line 3`"]
Copy link

changeset-bot bot commented Jun 29, 2025

⚠️ No Changeset found

Latest commit: 2223d80

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Jun 29, 2025

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 2223d80
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/686111770086150008020587
😎 Deploy Preview https://deploy-preview-6703--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

pkg-pr-new bot commented Jun 29, 2025

Open in StackBlitz

mermaid

npm i https://pkg.pr.new/mermaid-js/mermaid@6703

@mermaid-js/layout-elk

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6703

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6703

@mermaid-js/parser

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6703

@mermaid-js/tiny

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/tiny@6703

commit: 2223d80

Copy link

codecov bot commented Jun 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 3.82%. Comparing base (d9396ee) to head (2223d80).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6703   +/-   ##
=======================================
  Coverage     3.82%   3.82%           
=======================================
  Files          431     431           
  Lines        44487   44487           
  Branches       683     683           
=======================================
  Hits          1701    1701           
  Misses       42786   42786           
Flag Coverage Δ
unit 3.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

argos-ci bot commented Jun 29, 2025

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Jun 29, 2025, 10:21 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant