Skip to content

vrepsys/prose-ui

Repository files navigation

Prose UI - React components and styles for Markdown prose

Prose UI

Beautiful styling and React components for Markdown prose.

Prose UI is an open-source library of React components and customizable CSS styles for rendering Markdown and MDX content. It gives you polished typography and thoughtfully designed components for documentation sites, blogs, and any content-focused application.

Documentation · GitHub

Why Prose UI?

Every framework has its own conventions for MDX components, and most projects end up with a different—often incomplete—set of building blocks. Prose UI provides a shared set of polished, MDX-ready components that work across frameworks like Next.js, TanStack Start, or any React + MDX setup.

  • Markdown prose styling — Clean typography with sensible defaults and dark mode support
  • MDX components — Callouts, code blocks with syntax highlighting, tabs, steps, cards, tables, math formulas, and more
  • React components for Markdown — Use components directly in MDX or integrate with any React-based content renderer
  • Customizable — Token-based CSS styling system for easy theming
  • Framework-agnostic — Works with Next.js, TanStack Start, or any React + MDX pipeline

Installation

npm install @prose-ui/core @prose-ui/react @prose-ui/style

For Next.js projects, use @prose-ui/next instead of @prose-ui/react for optimized image and link components.

See the installation guide for detailed setup instructions.

Quick Start

// Import the css
import '@prose-ui/style/prose-ui.css'

import { mdxComponents } from '@prose-ui/react'

// Pass components to your MDX renderer
<MDXContent components={mdxComponents} />

// Wrap content with the prose-ui class
<div className="prose-ui">
  {/* Your rendered Markdown content */}
</div>

Components

Prose UI follows GitHub Flavored Markdown syntax and provides additional React components for features not natively supported by Markdown:

  • Typography — Headings, paragraphs, links, lists
  • Code Blocks — Syntax highlighting, line numbers, titles, code groups
  • Callouts — Info, warning, tip, and note variants
  • Tables — Styled tables with proper alignment
  • Images — Captions, alignment, and sizing controls
  • Tabs & Steps — Organize content with tabbed interfaces and step-by-step guides
  • Cards — Navigation cards and content highlights
  • Math — LaTeX formulas via KaTeX

Browse all components in the component documentation.

Development

This is a monorepo containing the website, docs, and source code for Prose UI packages.

pnpm install
cd apps/website
pnpm dev

Dhub — Visual Markdown Editor

Looking for a visual editing experience? Dhub is a git-based CMS for technical documentation with Notion-like Markdown editing. It commits directly to GitHub, so you keep your Git workflow with no lock-in. Prose UI was built alongside Dhub to provide the rendering layer.

License

MIT © Valdemaras Repšys

About

Refined typography and components for building content-focused websites with Next.js and MDX.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •