-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
Adding new diagram type - Block Diagram #5221
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Alois Klink <alois@aloisklink.com>
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
* develop: Update container Update container Remove pnpm cache Use `.node-version` file in workflows Remove node version from matrix Update to Node v20 Update to Node v20
…nto 3358-blocks-diagram
…nto 3358-blocks-diagram
aloisklink
approved these changes
Feb 1, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just delete the packages/mermaid/src/docs/syntax/block-old.md
file (see #5221 (comment)), then this looks good to me to merge :)
Thanks for going through all those comments, I imagine it must have been a pain to fix everything. 🚀
fuxingloh
referenced
this pull request
in fuxingloh/contented
Feb 3, 2024
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.7.0` -> `10.8.0`](https://renovatebot.com/diffs/npm/mermaid/10.7.0/10.8.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.8.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.8.0) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.7.0...v10.8.0) ### v10.8.0 #### Features <img width="375" alt="image" src="https://github.com/mermaid-js/mermaid/assets/5837277/c17405fb-2a06-4f7c-9c77-5eaba6c76747"> - Adding new diagram type - Block Diagram by [@​knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/5221](https://togithub.com/mermaid-js/mermaid/pull/5221) - Feature/5114 add parallel commit config by [@​mathbraga](https://togithub.com/mathbraga) in [https://github.com/mermaid-js/mermaid/pull/5161](https://togithub.com/mermaid-js/mermaid/pull/5161) - Changes to Gantt Parsers to allow hashes and semicolons to titles, sections, and task data. by [@​FutzMonitor](https://togithub.com/FutzMonitor) in [https://github.com/mermaid-js/mermaid/pull/5095](https://togithub.com/mermaid-js/mermaid/pull/5095) - Feature/4653 add actor-top class to sequence diagram by [@​Ronid1](https://togithub.com/Ronid1) in [https://github.com/mermaid-js/mermaid/pull/5241](https://togithub.com/mermaid-js/mermaid/pull/5241) #### Documentation - Updated gantt chart docs to show all config options by [@​murdoa](https://togithub.com/murdoa) in [https://github.com/mermaid-js/mermaid/pull/5192](https://togithub.com/mermaid-js/mermaid/pull/5192) - Contribution documentation improvements by [@​nirname](https://togithub.com/nirname) in [https://github.com/mermaid-js/mermaid/pull/5132](https://togithub.com/mermaid-js/mermaid/pull/5132) - Update flowchart.md - how to use font-awesome [#​5195](https://togithub.com/mermaid-js/mermaid/issues/5195) by [@​arukiidou](https://togithub.com/arukiidou) in [https://github.com/mermaid-js/mermaid/pull/5196](https://togithub.com/mermaid-js/mermaid/pull/5196) - Add more detailed docs for Gantt tasks by [@​sorenisanerd](https://togithub.com/sorenisanerd) in [https://github.com/mermaid-js/mermaid/pull/5194](https://togithub.com/mermaid-js/mermaid/pull/5194) - Docs/4974 reorder integration links by [@​Ronid1](https://togithub.com/Ronid1) in [https://github.com/mermaid-js/mermaid/pull/5066](https://togithub.com/mermaid-js/mermaid/pull/5066) - docs: fix swimm link by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [https://github.com/mermaid-js/mermaid/pull/5219](https://togithub.com/mermaid-js/mermaid/pull/5219) - Update Slack community links to Discord by [@​Olegt0rr](https://togithub.com/Olegt0rr) in [https://github.com/mermaid-js/mermaid/pull/5225](https://togithub.com/mermaid-js/mermaid/pull/5225) - Docs: Mermaid chart updates by [@​huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/5232](https://togithub.com/mermaid-js/mermaid/pull/5232) - Fix typos in timeline syntax samples by [@​sblom](https://togithub.com/sblom) in [https://github.com/mermaid-js/mermaid/pull/5139](https://togithub.com/mermaid-js/mermaid/pull/5139) #### Bug fixes - Bug/5059 fix external connection after updating edges by [@​mathbraga](https://togithub.com/mathbraga) in [https://github.com/mermaid-js/mermaid/pull/5127](https://togithub.com/mermaid-js/mermaid/pull/5127) - \[Fix] Sequence diagram actor menu popup by [@​vitorsss](https://togithub.com/vitorsss) in [https://github.com/mermaid-js/mermaid/pull/5160](https://togithub.com/mermaid-js/mermaid/pull/5160) - fix: Dompurify Hooks by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5236](https://togithub.com/mermaid-js/mermaid/pull/5236) - Accurate pie chart labeling for text alignment by [@​JenningsWilliam](https://togithub.com/JenningsWilliam) in [https://github.com/mermaid-js/mermaid/pull/5141](https://togithub.com/mermaid-js/mermaid/pull/5141) - fix: Redirect of old URLs by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5250](https://togithub.com/mermaid-js/mermaid/pull/5250) - Fixed Typo in ErrorRenderer.ts by [@​FutzMonitor](https://togithub.com/FutzMonitor) in [https://github.com/mermaid-js/mermaid/pull/5256](https://togithub.com/mermaid-js/mermaid/pull/5256) #### Chores - Revert "Revert 5041 feature/4935 subgraph title margin config option" by [@​mathbraga](https://togithub.com/mathbraga) in [https://github.com/mermaid-js/mermaid/pull/5205](https://togithub.com/mermaid-js/mermaid/pull/5205) - build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/mermaid-js/mermaid/pull/5200](https://togithub.com/mermaid-js/mermaid/pull/5200) - chore(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/5150](https://togithub.com/mermaid-js/mermaid/pull/5150) - E2E Image comparison by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5208](https://togithub.com/mermaid-js/mermaid/pull/5208) - E2E test by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5210](https://togithub.com/mermaid-js/mermaid/pull/5210) - Optimise caching of test results by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5213](https://togithub.com/mermaid-js/mermaid/pull/5213) - Update update-browserlist.yml to fix deprecation and action fails by [@​Abrifq](https://togithub.com/Abrifq) in [https://github.com/mermaid-js/mermaid/pull/5151](https://togithub.com/mermaid-js/mermaid/pull/5151) - UpdateCypress by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5228](https://togithub.com/mermaid-js/mermaid/pull/5228) - Use node v20 by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5248](https://togithub.com/mermaid-js/mermaid/pull/5248) - Convert Mindmap to TS by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5247](https://togithub.com/mermaid-js/mermaid/pull/5247) - chore: Add interface naming Convention by [@​sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/5254](https://togithub.com/mermaid-js/mermaid/pull/5254) #### New Contributors - [@​murdoa](https://togithub.com/murdoa) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5192](https://togithub.com/mermaid-js/mermaid/pull/5192) - [@​arukiidou](https://togithub.com/arukiidou) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5196](https://togithub.com/mermaid-js/mermaid/pull/5196) - [@​sorenisanerd](https://togithub.com/sorenisanerd) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5194](https://togithub.com/mermaid-js/mermaid/pull/5194) - [@​Ronid1](https://togithub.com/Ronid1) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5066](https://togithub.com/mermaid-js/mermaid/pull/5066) - [@​Olegt0rr](https://togithub.com/Olegt0rr) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5225](https://togithub.com/mermaid-js/mermaid/pull/5225) - [@​vitorsss](https://togithub.com/vitorsss) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5160](https://togithub.com/mermaid-js/mermaid/pull/5160) - [@​sblom](https://togithub.com/sblom) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5139](https://togithub.com/mermaid-js/mermaid/pull/5139) - [@​JenningsWilliam](https://togithub.com/JenningsWilliam) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/5141](https://togithub.com/mermaid-js/mermaid/pull/5141) **Full Changelog**: mermaid-js/mermaid@v10.7.0...v10.8.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
4 tasks
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
This PR introduces comprehensive support for Block Diagrams in Mermaid, offering users a versatile and intuitive way to represent complex systems, processes, or architectures visually. The new feature enhances the existing Mermaid suite by allowing for full control over the positioning of shapes, making it ideal for creating clear and concise block diagrams.
Resolves #3358
Example
Code:
📏 Design Decisions
The implementation of Block Diagrams in Mermaid focuses on user flexibility and ease of use. Key features include:
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSION
is used for all new features.develop
branch