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

Enable/fix markdown alert blocks + style rules. #8181

Merged
merged 3 commits into from
Oct 25, 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
2 changes: 2 additions & 0 deletions app/lib/shared/markdown.dart
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ const _whitelistedClassNames = <String>[
'changelog-content',
'hash-header',
'hash-link',
'markdown-alert',
'report-summary-icon',
];

Expand Down Expand Up @@ -115,6 +116,7 @@ String _renderSafeHtml(
!disableHashIds, // TODO: Use a denylist for ids used by pub site
allowClassName: (String cn) {
if (cn.startsWith('language-')) return true;
if (cn.startsWith('markdown-alert-')) return true;
return _whitelistedClassNames.contains(cn);
},
addLinkRel: (String url) {
Expand Down
13 changes: 13 additions & 0 deletions app/test/shared/markdown_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -403,4 +403,17 @@ void main() {
);
});
});

group('alert blocks', () {
test('note', () {
final output = markdownToHtml('> [!NOTE]\n> Extra information.');
expect(output.split('\n').toList(), [
'<div class="markdown-alert markdown-alert-note">',
'<p class="markdown-alert-title">Note</p>',
'<p>Extra information.</p>',
'</div>',
'',
]);
});
});
}
79 changes: 79 additions & 0 deletions pkg/web_css/lib/src/_alerts.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/* Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
for details. All rights reserved. Use of this source code is governed by a
BSD-style license that can be found in the LICENSE file. */

.markdown-alert {
margin-top: 1rem;
margin-bottom: 1rem;
padding: 1.25rem;

>:last-child {
margin-bottom: 0;
}

&.markdown-alert-note {
background-color: var(--pub-markdown-alert-info);

// NOTE: This is a copy of the dartdoc alert style, for using Material Symbols font.
// TODO: remove or fix this rule
// .markdown-alert-title:before {
// content: 'info';
// }
}

&.markdown-alert-tip {
background-color: var(--pub-markdown-alert-tip);

// NOTE: This is a copy of the dartdoc alert style, for using Material Symbols font.
// TODO: remove or fix this rule
// .markdown-alert-title:before {
// content: 'lightbulb';
// }
}

&.markdown-alert-important {
background-color: var(--pub-markdown-alert-important);

// NOTE: This is a copy of the dartdoc alert style, for using Material Symbols font.
// TODO: remove or fix this rule
// .markdown-alert-title:before {
// content: 'feedback';
// }
}

&.markdown-alert-warning {
background-color: var(--pub-markdown-alert-warning);

// NOTE: This is a copy of the dartdoc alert style, for using Material Symbols font.
// TODO: remove or fix this rule
// .markdown-alert-title:before {
// content: 'warning';
// }
}

&.markdown-alert-caution {
background-color: var(--pub-markdown-alert-error);

// NOTE: This is a copy of the dartdoc alert style, for using Material Symbols font.
// TODO: remove or fix this rule
// .markdown-alert-title:before {
// content: 'report';
// }
}
}

.markdown-alert-title {
display: flex;
align-items: center;
gap: 0.4rem;
margin-bottom: 0.5rem;

font-weight: bold;
-webkit-font-smoothing: antialiased;

// NOTE: This is a copy of the dartdoc alert style, for using Material Symbols font.
// TODO: remove or fix this rule
// &:before {
// font: 24px / 1 'Material Symbols Outlined';
// }
}
14 changes: 14 additions & 0 deletions pkg/web_css/lib/src/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@
--pub-inset-bgColor: var(--pub-color-smokeWhite);
--pub-selected-bgColor: var(--pub-color-bubblesBlue);

// TODO: adjust colors (copied from dartdoc style) to blend in better with the pub.dev design
--pub-markdown-alert-info: #e7f8ff;
--pub-markdown-alert-tip: #ecfaf7;
--pub-markdown-alert-important: #e2dbff;
--pub-markdown-alert-warning: #fcf8e3;
--pub-markdown-alert-error: #fde9ee;

--pub-default-headline-font_family: "Google Sans Display", "Google Sans", "Roboto", sans-serif;
--pub-default-text-font_family: "Google Sans Text", "Google Sans", "Roboto", sans-serif;
--pub-code-text-color: var(--pub-neutral-textColor);
Expand Down Expand Up @@ -116,6 +123,13 @@
--pub-inset-bgColor: var(--pub-color-anchorBlack);
--pub-selected-bgColor: var(--pub-color-nipponUltraBlue);

// TODO: adjust colors (copied from dartdoc style) to blend in better with the pub.dev design
--pub-markdown-alert-info: #043875;
--pub-markdown-alert-tip: #065517;
--pub-markdown-alert-important: #4a00b4;
--pub-markdown-alert-warning: #7b6909;
--pub-markdown-alert-error: #7a0c17;

--pub-code-text-color: var(--pub-neutral-textColor);
--pub-link-text-color: #40c4ff;
--pub-badge-default-color: var(--pub-link-text-color);
Expand Down
2 changes: 1 addition & 1 deletion pkg/web_css/lib/style.scss
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// Include third-party CSS into a single output file
// to reduce the number of HTTP requests.
@use '../../../third_party/css/github-markdown.css';
@use '../../../third_party/css/dartdoc-github-alert.css';

.light-theme {
@import "../../../third_party/highlight/github";
Expand All @@ -14,6 +13,7 @@
// Local styles and rules.
@import 'src/_variables';
@import 'src/_base';
@import 'src/_alerts';
@import 'src/_site_header';
@import 'src/_activity_log';
@import 'src/_detail_page';
Expand Down
17 changes: 0 additions & 17 deletions pkg/web_css/test/dartdoc_github_alert_test.dart

This file was deleted.

10 changes: 9 additions & 1 deletion pkg/web_css/test/expression_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,18 @@ void main() {
'cookie-notice-container',
'cookie-notice-button',
]);
// markdown alert classes
expressions.removeAll([
'markdown-alert-note',
'markdown-alert-tip',
'markdown-alert-important',
'markdown-alert-warning',
'markdown-alert-caution',
'markdown-alert-title',
]);

// remove third-party css expressions
final thirdPartyCss = [
'../../third_party/css/dartdoc-github-alert.css',
'../../third_party/css/github-markdown.css',
'../../third_party/highlight/github.css',
'../../third_party/highlight/github-dark.css',
Expand Down
41 changes: 0 additions & 41 deletions third_party/css/dartdoc-github-alert.css

This file was deleted.

Loading