Skip to content
CraftDocs
GitHub
Home
Home
Changelog
What's New
Guide
Guide
Getting Started
Principles
Styling Components
Theme System
Foundations
All Tokens
Color
Elevation
Icons
Motion
Shape
Spacing
Typography
Libraries
Libraries
@xds/cli
@xds/core
Themes
Themes
Theme: daily
Default Theme
Theme: matcha
Neutral Theme
Components
Components
AppShell
AspectRatio
Avatar
Avatar
AvatarStatusDot
Badge
Banner
Breadcrumbs
BreadcrumbItem
Breadcrumbs
Button
Button
IconButton
ToggleButton
ToggleButtonGroup
Calendar
Card
Carousel
Chat
ChatComposer
ChatComposerDrawer
ChatComposerInput
ChatComposerTokenElement
ChatDictationButton
ChatLayout
ChatLayoutScrollButton
ChatMessage
ChatMessageBubble
ChatMessageList
ChatMessageMetadata
ChatSendButton
ChatSystemMessage
ChatTokenizedText
ChatToolCalls
Checkbox
CheckboxInput
CheckboxList
CheckboxListItem
ClickableCard
Code
CodeBlock
Collapsible
Collapsible
CollapsibleGroup
useXDSCollapsible
CommandPalette
CommandPalette
CommandPaletteEmpty
CommandPaletteFooter
CommandPaletteGroup
CommandPaletteInput
CommandPaletteItem
CommandPaletteList
DateInput
Dialog
AlertDialog
Dialog
DialogHeader
useXDSImperativeAlertDialog
useXDSImperativeDialog
Divider
DropdownMenu
DropdownMenu
DropdownMenuDivider
DropdownMenuItem
DropdownMenuItemData
DropdownMenuSection
EmptyState
Field
Field
FieldLabel
FieldStatus
Heading
HoverCard
Icon
Kbd
Layout
Center
FormLayout
Grid
GridSpan
HStack
Layout
LayoutContainer
LayoutContent
LayoutFooter
LayoutHeader
LayoutPanel
Section
StackItem
VStack
Link
List
List
ListItem
Markdown
MetadataList
MetadataList
MetadataListItem
MobileNav
MoreMenu
NavHeadingMenu
NavIcon
NumberInput
OverflowList
Pagination
Popover
PowerSearch
ProgressBar
Radio
RadioList
RadioListItem
Resizable
ResizeHandle
useXDSResizable
SegmentedControl
SegmentedControl
SegmentedControlItem
SelectableCard
Selector
MultiSelector
Selector
SelectorOption
SideNav
SideNav
SideNavCollapseButton
SideNavHeading
SideNavItem
SideNavSection
Skeleton
Slider
Spinner
StatusDot
Switch
Table
BaseTable
Table
TableCell
TableHeaderCell
TableRow
useXDSTableColumnSettings
useXDSTablePagination
useXDSTableSelection
useXDSTableSelectionState
useXDSTableSortable
Tabs
Tab
TabList
TabMenu
Text
TextArea
TextInput
Thumbnail
TimeInput
Timestamp
Toast
Toast
useXDSToast
Token
Tokenizer
Toolbar
Tooltip
TopNav
TopNav
TopNavHeading
TopNavItem
TopNavMegaMenu
TopNavMegaMenuFeaturedCard
TopNavMegaMenuItem
TopNavMenu
TreeList
Typeahead
BaseTypeahead
Typeahead
TypeaheadItem
useXDSHoverCard
useXDSPopover
useXDSTooltip
Utilities
Utilities
LinkProvider
MediaTheme
SyntaxTheme
Theme
useClickableContainer
useEntryAnimation
useFocusTrap
useGridFocus
useImageMode
useInputContainer
useListFocus
useMediaQuery
useOverflow
useScrollLock
useScrollOverflow
useXDSLayer
useXDSStreamingText
Terms of UsePrivacy Policy
Type to search
↑↓Navigate↵SelectEscClose
Markdown@xds/core · XDSMarkdown v0.0.13

Usage

Renders a markdown string as XDS-styled components. Use Markdown for user-generated content, AI responses, and documentation — it handles headings, lists, tables, code blocks, and citations with consistent styling.
ts
import {XDSMarkdown} from '@xds/core/Markdown'

Best practices

GuidancePractices
DoSet headingLevelStart to match the page hierarchy — e.g. start at 3 if the markdown sits inside an h2 section.
DoUse contentWidth to keep prose at a readable line length in wide layouts.
Don'tUse Markdown for hand-authored layouts — use XDSText and XDSHeading directly when you control the content.

Examples

Common configurations, variations, and states.
Markdown — Cited ContentMarkdown with citation chips linked to external sources
tsx
'use client';
​
import {XDSMarkdown} from '@xds/core/Markdown';
​
const sources = {
abc1: {
title: 'Tokyo - Wikipedia',
url: 'https://en.wikipedia.org/wiki/Tokyo',
icon: 'https://en.wikipedia.org/favicon.ico',
},
def2: {
title: 'Japan Statistics Bureau - Population',
url: 'https://www.stat.go.jp/english/',
},
ghi3: {
title: 'World Population Review',
url: 'https://worldpopulationreview.com/world-cities/tokyo-population',
},
jkl4: {
title: 'Reuters — Tokyo GDP',
url: 'https://www.reuters.com/markets/',
icon: 'https://www.reuters.com/favicon.ico',
},
mno5: {
title: 'UN Urbanization Prospects',
url: 'https://population.un.org/wup/',
},
};
​
const content = [
'## Tokyo Overview',
'',
'Tokyo is the capital of Japan with a population of over 14 million[abc1].',
"It's the most populous metropolitan area in the world[def2][ghi3].",
'',
'### Economy',
'',
"Tokyo's GDP exceeds $1.9 trillion, making it the largest city economy globally[jkl4].",
'The metropolitan area is expected to remain the most populous urban agglomeration through 2035[mno5].',
'',
'### Key Facts',
'',
'- Population: 13.96 million (city proper)[abc1]',
'- Metro area: 37.4 million[def2]',
'- GDP: $1.93 trillion[jkl4]',
].join('\n');
​
export default function MarkdownCitedContent() {
return (
<XDSMarkdown sources={sources} density="compact" headingLevelStart={3}>
{content}
</XDSMarkdown>
);
}
Markdown — Compact AI ResponseCompact markdown styled for AI responses with shifted heading levels
tsx
'use client';
​
import {XDSMarkdown} from '@xds/core/Markdown';
​
const content = [
'## Setting Up a Design System',
'',
"A design system is more than a component library — it's a **shared language** between design and engineering.",
'',
'### 1. Start with Tokens',
'',
'Design tokens are the atomic values that define your visual language:',
'',
'```typescript',
'const tokens = {',
' color: {',
" primary: '#0066FF',",
" secondary: '#6B7280',",
' },',
' spacing: {',
" sm: '8px',",
" md: '16px',",
" lg: '24px',",
' },',
'};',
'```',
'',
'### 2. Component Architecture',
'',
'Good components follow these principles:',
'',
'- **Composable** — small pieces that combine into complex UIs',
'- **Accessible** — keyboard navigation and screen reader support built-in',
'- **Themeable** — visual customization without forking',
'',
'> The best design systems are *opinionated enough* to ensure consistency, but *flexible enough* to handle edge cases gracefully.',
].join('\n');
​
export default function MarkdownCompactAIResponse() {
return (
<XDSMarkdown density="compact" headingLevelStart={3}>
{content}
</XDSMarkdown>
);
}
Markdown — Data TableComparison table rendered from a markdown string
tsx
'use client';
​
import {XDSMarkdown} from '@xds/core/Markdown';
​
const content = [
'## Comparison Table',
'',
'| Feature | React | Vue | Svelte |',
'|:--------|:-----:|:---:|-------:|',
'| Virtual DOM | Yes | Yes | No |',
'| Bundle Size | ~40KB | ~30KB | ~2KB |',
'| TypeScript | Native | Plugin | Native |',
'| Learning Curve | Medium | Easy | Easy |',
].join('\n');
​
export default function MarkdownDataTable() {
return <XDSMarkdown>{content}</XDSMarkdown>;
}
Markdown — Rich ContentMarkdown with headings, lists, code blocks, tables, blockquotes, and task lists
tsx
'use client';
​
import {XDSMarkdown} from '@xds/core/Markdown';
​
const content = [
'# XDSMarkdown Demo',
'',
'Renders **markdown** with *design-system-consistent* styling.',
'',
'## Features',
'',
'- Headings mapped to XDS type scale',
'- **Bold**, *italic*, and ~~strikethrough~~ text',
'- [Links](https://example.com) with external detection',
'- Inline `code` and fenced code blocks',
'',
'### Code Block',
'',
'```typescript',
'interface User {',
' id: string;',
' name: string;',
'}',
'',
'function greet(user: User) {',
' return `Hello, ${user.name}!`;',
'}',
'```',
'',
'### Blockquote',
'',
'> Design systems free teams to focus on problems that matter.',
'',
'### Table',
'',
'| Component | Status | Tests |',
'|:----------|:------:|------:|',
'| XDSMarkdown | Active | 73 |',
'| XDSCodeBlock | Active | 44 |',
'',
'### Task List',
'',
'- [x] Parser',
'- [x] Renderer',
'- [ ] Storybook stories',
'',
'---',
'',
'1. First ordered item',
'2. Second ordered item',
].join('\n');
​
export default function MarkdownRichContent() {
return <XDSMarkdown>{content}</XDSMarkdown>;
}

Showcase source

tsx
'use client';
​
import {XDSMarkdown} from '@xds/core/Markdown';
​
const content = [
'# Markdown Demo',
'',
'Renders **markdown** with *design-system-consistent* styling.',
'',
'## Features',
'',
'- Headings mapped to the XDS type scale',
'- **Bold**, *italic*, and ~~strikethrough~~ text',
'- [Links](https://example.com) with external detection',
'- Inline `code` and fenced code blocks',
'',
'> Design systems free teams to focus on problems that matter.',
].join('\n');
​
export default function MarkdownShowcase() {
return <XDSMarkdown>{content}</XDSMarkdown>;
}