saturation/uisaturation/ui
DocsComponentsBlocksPagesEmails
GitHub

Sections

IntroductionComponentsInstallationMCPThemingDesignComposing a Detail Panel

Components

Components

General

AvatarBadgeButtonKbdProgressSeparatorSkeletonSpin ResolveSpinnerSplit ButtonSync ButtonTypography

Forms & Inputs

Address LookupCalendar PickerCheckboxColor PickerComboboxDate PickerEmoji PickerFavicon SearchFieldInputInput GroupInput OTPRadio GroupSelectSliderSwitchTextareaToggleToggle Group

Data Display

AccordionAlertCardChartComparison SliderCredit CardData TableEmptyItemMarkdownSaturation Credit CardStatus BadgeTableTree

Detail Panels

Detail FieldDetail HeroDetail Toolbar

Navigation

BreadcrumbCommandMenubarNavigation MenuPaginationTabs

Overlays

CollapsibleContext MenuDialogDropdown MenuHover CardSheet

Layout

Button GroupFont ProviderWizard Split Layout

Feedback

Sonner

Animation & Effects

Animated GroupAnimated ListAnimated NumberBeamBlur FadeBorder TrailGlow EffectLiquid MetalLoading StateParallaxPixelProgressive BlurRippleSpotlightText EffectText Shimmer

Productivity

Agent ChatAI Chat InputCoding AgentFiltersFull CalendarKanbanNovel Editor
Docs/Components/Markdown

Markdown

Renders GitHub-flavored markdown with Saturation typography and optional trusted raw HTML.

Loading...

Installation

pnpm dlx shadcn@latest add @saturation-ui/markdown

Tailwind v4 — Source Scanning

The public shadcn registry installs component source into your project. If Tailwind v4 isn't scanning your components directory, add this to your CSS entry file:

@source "../components";

This ensures all utility classes in CVA variants and data attribute selectors are included in your build.

Usage

import { Markdown } from "@/components/ui/markdown"
<Markdown>{"## Production notes\n\n- Camera confirmed"}</Markdown>

Raw HTML is disabled by default. Only enable allowRawHtml for content that has already crossed a trusted sanitization boundary.

API Reference

PropTypeDefaultDescription
children*string | null | undefined—Markdown source to render.
componentsreact-markdown Components—Element renderer overrides.
allowRawHtmlbooleanfalseAllows trusted raw HTML through rehype-raw. Keep disabled for untrusted content.
classNamestring—Additional classes for the root container.
PreviousLoading StateNextMenubar

On This Page

  • Installation
  • Usage
  • API Reference

Production notes

  • Camera package confirmed
  • Location release pending

See the budget for current totals.