VSCode: add recommended extensions, fix link to admonition styling CSS for markdown previews - #4455
Open
ewels wants to merge 2 commits into
Open
VSCode: add recommended extensions, fix link to admonition styling CSS for markdown previews#4455ewels wants to merge 2 commits into
ewels wants to merge 2 commits into
Conversation
…S for markdown previews
Codecov Report✅ All modified and coverable lines are covered by tests. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
mahesh-panchal
approved these changes
Aug 26, 2026
mahesh-panchal
left a comment
Member
There was a problem hiding this comment.
I had to catch up on the slack thread https://nfcore.slack.com/archives/C043UU89KKQ/p1787644811361209, because I thought this wasn't wanted. I guess it doesn't make a whole lot of difference though. It's useful for the people that can use it, and no difference to the people that don't.
Aside from the missing ChangeLog entry 👍🏽
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
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.
I added in the settings file to point to the CSS file for docs admonition styling in markdown previews, back in 2024. But I made a copy-paste error so it never worked. See nf-core/website#2579 for original feature.
Fixing the path here to be a URL, that does something and actually works now (tested locally).
Also added a new
extensions.jsonfile that gets VS Code to show a little pop-up recommending that the user installs the listed plugins. I've done it as a slightly conservative sub-list of https://github.com/nf-core/vscode-extensionpackThese recommended extensions include Markdown Extended, which is needed for the admonition styling to work.
Side note: comments are tolerated in JSON files for VSCode. Tested locally and fine.
PR checklist
CHANGELOG.mdis updateddocsis updated