Let group optionally display description info below nodes within the group#5389
Open
Let group optionally display description info below nodes within the group#5389
Conversation
…group to help folk doc flows more visibly
uses --- or *** or ___
Contributor
|
Would be lovely if the text was rendered markdown? Perhaps a foreignObject would work (and perhaps simpler than computing SVG elements from split text?)? 🤔 Something like <svg xmlns="http://www.w3.org/2000/svg">
<foreignObject width="100%" height="100%">
<div xmlns="http://www.w3.org/1999/xhtml">
<rendered markdown here>
</div>
</foreignObject>
</svg> |
Member
Author
|
OK - I'll let you work out the maths for the size of the group boundary ! Though I do feel that as others have pointed out - if we went full markdown and diagrams in the editor it would take up too much space permanently... the compressed font and text that we have now doesn't seem too bad... so I'm not feeling the urge to try for extending to markdown rendering. Of course other PR's are available... I think there are better options for much wordier docs - like click to expand or separate windows etc. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
…group
to help folk doc flows more visibly
Proposed changes
Based of this discussion https://discourse.nodered.org/t/ways-to-improve-flow-documentation/99924
This PR adds an optional checkbox to the group config that when enabled shows the raw text from the description tab as visible text below the nodes in the group.
We can't easily render markdown as SVG so this just adds the raw text - but does respect line breaks so the user can create useful documentation.
Checklist
npm run testto verify the unit tests pass