Aside

Supporting article content outside the main reading flow.

MDX@gaudi/design-system/mdx/AsideView in Storybook Source

Installation

pnpm add github:ahmadassaf/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import Aside from '@gaudi/design-system/mdx/Aside';

Usage

<Aside>  Additional context for the article that should sit outside the main argument.</Aside>

Examples

Playground

API

2 props

Accessibility

Keep the aside understandable in document order and give distinct sections headings when needed.

CalloutHighlight an article note, tip, warning or error while preserving readable prose.ChartChart is the MDX adapter for the Charts collection: authors write <Chart type=…> (or a chart by name) in an article and get the same framed, accessible chart an application renders from @gaudi/design-system/charts.CitationCitation documents the blog citation authoring flow and the Gaudi runtime components that hydrate generated citation links.CitationTrackerKeep bibliography back-links associated with the last visited citation.CodeArticle code rendered through the Core CodeBlock: CodeFence maps MDX pre, CodeGroup renders ::: code-group fences as tabs.DetailsExpandable article details with an explicit summary.