Skip to content

fix(theme): <Admonition> should render properly without heading/icon #10080

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
slorber merged 2 commits into from
Apr 30, 2024
Merged

fix(theme): <Admonition> should render properly without heading/icon #10080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2099a9a
feat: display admonition without heading
andrmaz Apr 26, 2024
18ad488
feat: add admonition dogfooding test
andrmaz Apr 27, 2024
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: 1 addition & 1 deletion packages/docusaurus-theme-classic/src/theme/Admonition/Layout/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export default function AdmonitionLayout(props: Props): JSX.Element {
const {type, icon, title, children, className} = props;
return (
<AdmonitionContainer type={type} className={className}>
<AdmonitionHeading title={title} icon={icon} />
{title || icon ? <AdmonitionHeading title={title} icon={icon} /> : null}
<AdmonitionContent>{children}</AdmonitionContent>
</AdmonitionContainer>
);
Expand Down
14 changes: 14 additions & 0 deletions website/_dogfooding/_pages tests/markdown-tests-mdx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,20 @@ test

::::

```mdx-code-block
import Admonition from '@theme/Admonition';

export function AdmonitionWithoutHeading(props) {
return (
<Admonition {...props} type="info" icon={null} title={null}>
Admonition content without heading
</Admonition>
);
}
```

<AdmonitionWithoutHeading />

## Linking

This is a test page to see if Docusaurus Markdown features are working properly
Expand Down