Skip to content
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

VSCode admonition styling using 'Markdown Extended' #2579

Merged
merged 2 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"markdown.styles": [
"public/vscode_markdown.css"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

]
}
30 changes: 30 additions & 0 deletions public/vscode_markdown.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.note {
border-radius: .25rem;
border: 2px solid #084298;
padding: 1rem 1rem 0;
margin-bottom: 1rem;
}
.info {
border-radius: .25rem;
border: 2px solid #0e616e;
padding: 1rem 1rem 0;
margin-bottom: 1rem;
}
.tip {
border-radius: .25rem;
border: 2px solid #14683b;
padding: 1rem 1rem 0;
margin-bottom: 1rem;
}
.warning {
border-radius: .25rem;
border: 2px solid #997404;
padding: 1rem 1rem 0;
margin-bottom: 1rem;
}
.danger {
border-radius: .25rem;
border: 2px solid #842029;
padding: 1rem 1rem 0;
margin-bottom: 1rem;
}