-
-
Notifications
You must be signed in to change notification settings - Fork 8k
Update flowchart.md with explicit line break example #6703
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
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`"]
|
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mermaid
@mermaid-js/layout-elk
@mermaid-js/mermaid-zenuml
@mermaid-js/parser
@mermaid-js/tiny
commit: |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #6703 +/- ##
=======================================
Coverage 3.82% 3.82%
=======================================
Files 431 431
Lines 44487 44487
Branches 683 683
=======================================
Hits 1701 1701
Misses 42786 42786
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
📑 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:
with an explicit example using
<br/>
for a line break: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
MERMAID_RELEASE_VERSION
is used for all new features.pnpm changeset
and following the prompts. Changesets that add features should beminor
and those that fix bugs should bepatch
. Please prefix changeset messages withfeat:
,fix:
, orchore:
.