VSCode admonition styling using 'Markdown Extended' #2579
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
✅ Deploy Preview for nf-core-main-site ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mashehu
reviewed
Jun 13, 2024
| @@ -0,0 +1,5 @@ | |||
| { | |||
| "markdown.styles": [ | |||
| "public/vscode_markdown.css" | |||
There was a problem hiding this comment.
Suggested change
| "public/vscode_markdown.css" | |
| ".vscode/vscode_markdown.css" |
I don't think this needs to shipped with the website build. so I would just put it in the .vscode folder
There was a problem hiding this comment.
It was deliberate to make it public, in case we want to add the VSCode config to all pipelines (which I assume we might want to at some point).
Even if we don't do that, we could have it as a documented thing that people can add to their global VSCode configuration so that it works wherever.
In both cases it's useful to have the file public.
✅ Deploy Preview for nf-core-docs canceled.
|
mashehu
approved these changes
Oct 4, 2024
This was referenced Oct 4, 2024
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.
Use https://github.com/qjebbs/vscode-markdown-extended to render admonitions in VSCode.
Requires this extension:
jebbs.markdown-extended1.1.4jebbsThen does an imperfect but not-too-bad job of rendering admonitions in markdown previews in VSCode:
Currently set to use workspace VSCode settings. This won't work when writing docs in pipeline repos. If we want to do that, we'll need to use a https URL to the stylesheet (not a problem once this is merged) and then add a
.vscodedirectory to the template with this settings file (which I like less).We could then include this VSCode extension into the nf-core VSCode package so that the majority of users will have it automagically.
'cc @FloWuenne @mahesh-panchal