Skip to content

Readme markdown refactor for legibility in IDE's#5423

Merged
knolleary merged 11 commits intonode-red:masterfrom
dimitrieh:readme-markdown-refactor
Jan 7, 2026
Merged

Readme markdown refactor for legibility in IDE's#5423
knolleary merged 11 commits intonode-red:masterfrom
dimitrieh:readme-markdown-refactor

Conversation

@dimitrieh
Copy link
Copy Markdown
Contributor

@dimitrieh dimitrieh commented Jan 7, 2026 •
edited
Loading

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Readme update

Proposed changes

Make the readme more legible in IDE's. See #5340 (comment)

Checklist

  • I have read the contribution guidelines
  • For non-bugfix PRs, I have discussed this change on the forum/slack team.
  • I have run npm run test to verify the unit tests pass
  • I have added suitable unit tests to cover the new/changed functionality

dimitrieh added 11 commits January 7, 2026 10:23
@dimitrieh
Refactor README to use Markdown syntax with reference-style links
906d63a 
- Convert badge links from HTML <a><img> to Markdown [![]()]() syntax
- Use reference-style links to keep header section clean and readable
- Move all badge URLs to bottom of file for easier maintenance
- Reduce header section from ~45 lines to ~27 lines
@dimitrieh
Centering
0d45b39
@dimitrieh
Spacing
8f67320
@dimitrieh
Improved layout
287d3b3
@dimitrieh
Layout improvements
b183b7f
@dimitrieh
Layout improvements
caa50bc
@dimitrieh
Layout improvements
7ee047c
@dimitrieh
Layout improvements
f217256
@dimitrieh
Layout improvements
752ea70
@dimitrieh
Optimisations
22ec628
@dimitrieh
Optimisation
a678e4b
@dimitrieh
Copy link
Copy Markdown
Contributor Author

dimitrieh commented Jan 7, 2026

@dceejay @Semmu please have a look

@dimitrieh dimitrieh mentioned this pull request Jan 7, 2026
Merged
4 tasks
@dimitrieh
Copy link
Copy Markdown
Contributor Author

dimitrieh commented Jan 7, 2026 •
edited
Loading

@dceejay a separate issue in our readme instructions is npm install. Is it advisable? In this time and age of NPM supply chain attacks we might want to change this.

Edit: updated this comment to remove confusion

@dimitrieh dimitrieh mentioned this pull request Jan 7, 2026
Open
@dceejay
Copy link
Copy Markdown
Member

dceejay commented Jan 7, 2026

Which bit do you find "interesting" ?

@dimitrieh dimitrieh mentioned this pull request Jan 7, 2026
Closed
@dimitrieh
Copy link
Copy Markdown
Contributor Author

dimitrieh commented Jan 7, 2026 •
edited
Loading

@dceejay ideally we should strive to ensure fully reproducible dependency chains. I have opened a separate issue for that at #5424.

Edit: updated this comment to remove confusion

@knolleary knolleary merged commit ebc2da1 into node-red:master Jan 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dimitrieh @dceejay @knolleary