Highlight

Inline emphasis within article text.

MDX@gaudi/design-system/mdx/HighlightView 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 Highlight from '@gaudi/design-system/mdx/Highlight';

Usage

Use <Highlight>inline emphasis</Highlight> inside normal article prose.

Examples

Playground

API

1 prop

Accessibility

Highlighted text stays in the normal reading order; do not rely on color alone for meaning.

AsideSupporting article content outside the main reading flow.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.