Skip to content

Add admonition feature #210

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 23, 2022
Merged

Add admonition feature #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 47 additions & 1 deletion src/components/pages/Documentation/Markdown/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,50 @@ const Toggle: React.FC<{
)
}

const icons = {
tip: '💡',
info: 'ℹ️',
warn: '⚠️',
fire: '🔥',
exclamation: '❗',
lady_beetle: '🐞',
bug: '🐛'
}
const genericTitles = {
info: 'Info',
tip: 'Tip',
warn: 'Warning'
}
const defaultType = 'info'

const Admonition: React.FC<{
title?: string
type?: 'info' | 'tip' | 'warn'
icon?:
| 'tip'
| 'info'
| 'warn'
| 'fire'
| 'exclamation'
| 'lady_beetle'
| 'bug'
}> = ({ title, type = defaultType, children, icon = type }) => {
const setType = genericTitles[type] ? type : defaultType
const iconContent = icons[icon] || ''

return (
<div
className={cn(styles.admonition, styles[setType])}
style={{ '--icon': `"${iconContent}"` } as React.CSSProperties}
>
<p className={cn(styles.title, !iconContent && styles.noIcon)}>
{title || genericTitles[setType]}
</p>
<div className={styles.admonitionContent}>{children}</div>
</div>
)
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
const renderAst = new (rehypeReact as any)({
createElement: React.createElement,
Expand All @@ -221,7 +265,9 @@ const renderAst = new (rehypeReact as any)({
card: Card,
cards: Cards,
toggle: Toggle,
tab: React.Fragment
tab: React.Fragment,
admon: Admonition,
admonition: Admonition
}
}).Compiler

Expand Down
45 changes: 45 additions & 0 deletions src/components/pages/Documentation/Markdown/styles.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,3 +494,48 @@ a.card {
overflow: hidden;
width: 0;
}

.admonition {
padding: 10px;
border-left-style: solid;
margin-bottom: 10px;
border-radius: 10px;
border-left-width: 10px;

&.warn {
border-color: var(--color-orange);
background-color: rgb(227 112 70 / 20%);
}

&.tip {
border-color: var(--color-azure);
background-color: rgb(19 173 199 / 20%);
}

&.info {
border-color: var(--color-purple);
background-color: rgb(148 93 214 / 20%);
}

.title {
font-weight: 500;
margin: 0;
}

.title::before {
margin-right: 5px;
content: var(--icon);
}

.title.noIcon::before {
margin-right: 0;
}

.admonitionContent {
padding: 10px 0 0;
}

.admonitionContent *:last-child {
margin-bottom: 0;
}
}