Skip to content
mdxcn is now part of Shadcn Labs. details

introduction

mdxcn is a set of React components for documentation, drawn with text: callouts, steps, timelines, tables and small charts. Every example in these docs has three tabs. .mdx is what you write in an MDX page, .tsx is the same figure in plain React, and .md is the figure as a code block you can paste into Notion, Linear or a README.

New here? Start with installation for the CLI and the mdx-components setup. Examples are complete write-ups with two figures each, for agents covers the agent skill, and Comark and Knap render the same graphs from plain .md files.

[ tip ]
The .md tab is the figure itself: the dashed frame, the title and the glyphs, all as text. Paste it into Notion or a README and it looks the same there. The rules for writing it are on the grammar page.

install

The CLI copies a component into your repo. You can also copy the files from GitHub by hand.

command

components

47 total

[ content ]

Markdown you'd write anyway, framed: callouts, steps, shell sessions, release notes, code notes, decisions, chats, env files, API routes, shortcuts and FAQs.

[ diagrams ]

Paths, trees, timelines, schedules and boards, written as lists inside the tag.

[ data ]

Numbers with labels: stats, specs, tables and diffs.

[ charts ]

Glyphs on a track: rankings, meters, sparklines and grids.

[ time ]

Days and clocks: uptime, a month view, elapsed time and countdowns.

[ primitives ]

The frame every component is drawn in.