Skip to content

Commit 015cf5e

Browse files
committed
Added 'successTip' admonition with green background color.
1 parent 9a0a02a commit 015cf5e

File tree

5 files changed

+23
-3
lines changed

5 files changed

+23
-3
lines changed

docs/welcome.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import HomepageFeatures from "@site/src/components/features/HomepageFeatures";
99

1010
# Welcome
1111

12-
:::caution Berkeley Mainnet release has landed
12+
:::successTip Berkeley Mainnet release has landed
1313

1414
Please make sure to upgrade your mina nodes to **3.0.0** ([Release notes](https://github.com/MinaProtocol/mina/releases/tag/3.0.0))
1515
[See instructions on how to upgrade your Mina node](/berkeley-upgrade/requirements).

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ module.exports = {
258258
'caution',
259259
'danger',
260260
'experimental',
261+
'successTip',
261262
],
262263
},
263264
},

src/scss/utilities/_variables.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ $mina-white: #ffffff;
1414
$mina-error: #e93939;
1515
$mina-purple: #5362c8;
1616
$mina-lavender: #cab2ff;
17+
$mina-green: green;

src/theme/Admonition/index.tsx

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import React, { type ReactNode } from 'react';
21
import Translate from '@docusaurus/Translate';
32
import type { Props } from '@theme/Admonition';
3+
import React, { type ReactNode } from 'react';
44

55
import styles from './styles.module.scss';
66

@@ -90,7 +90,6 @@ const AdmonitionConfigs: Record<Props['type'], AdmonitionConfig> = {
9090
</Translate>
9191
),
9292
},
93-
9493
note: {
9594
infimaClassName: 'secondary',
9695
iconComponent: NoteIcon,
@@ -151,6 +150,18 @@ const AdmonitionConfigs: Record<Props['type'], AdmonitionConfig> = {
151150
</Translate>
152151
),
153152
},
153+
successTip: {
154+
infimaClassName: 'green',
155+
iconComponent: NoteIcon,
156+
label: (
157+
<Translate
158+
id="theme.admonition.note"
159+
description="The default label used for the SuccessTip admonition (:::successTip)"
160+
>
161+
successTip
162+
</Translate>
163+
),
164+
},
154165
};
155166

156167
// Legacy aliases, undocumented but kept for retro-compatibility
@@ -159,6 +170,7 @@ const aliases = {
159170
important: 'info',
160171
success: 'tip',
161172
warning: 'danger',
173+
successTip: 'successTip',
162174
} as const;
163175

164176
function getAdmonitionConfig(unsafeType: string): AdmonitionConfig {
@@ -230,6 +242,8 @@ export default function Admonition(props: Props): JSX.Element {
230242
admonitionStyles = styles.admonitionDanger;
231243
} else if (type === 'experimental') {
232244
admonitionStyles = styles.admonitionExperimental;
245+
} else if (type === 'successTip') {
246+
admonitionStyles = styles.admonitionSuccessTip;
233247
}
234248

235249
return (

src/theme/Admonition/styles.module.scss

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@
5454
@include admonition($backgroundColor: variables.$mina-orange);
5555
}
5656

57+
.admonitionSuccessTip {
58+
@include admonition($backgroundColor: variables.$mina-green);
59+
}
60+
5761
.admonitionHeading code {
5862
text-transform: none;
5963
}

0 commit comments

Comments
 (0)