Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Layout

Prose

Adds readable spacing and typography to rendered Markdown or CMS content.

FrameworksAstro · React · Elements

Registry commandlumen add Prose

InteractionNative markup

01

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

AstroCode target · live preview uses Astro

Build with semantic primitives

Lumen keeps accessible markup, theme tokens, and interaction contracts aligned.

  • Start with Astro.
  • Adapt the same API to React or Elements.

Content should stay readable when a theme, language, or viewport changes.

Use Prose for semantic Markdown output and Code for enhanced examples.

ContentPurpose
Headings and linksStructure and navigation
Tables and quotationsComparison and context
View Prose code

Framework usage

Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.
astro
---
import { Prose } from '@santi020k/lumen-astro'
---

<Prose>
  <h3>Build with semantic primitives</h3>
  <p>Lumen keeps accessible markup, theme tokens, and interaction contracts aligned.</p>
  <ul>
    <li>Start with Astro.</li>
    <li>Adapt the same API to React or Elements.</li>
  </ul>
  <blockquote>
    <p>Content should stay readable when a theme, language, or viewport changes.</p>
  </blockquote>
  <p>Use <code>Prose</code> for semantic Markdown output and <a href="/docs/components/code">Code</a> for enhanced examples.</p>
  <table>
    <thead><tr><th scope="col">Content</th><th scope="col">Purpose</th></tr></thead>
    <tbody>
      <tr><th scope="row">Headings and links</th><td>Structure and navigation</td></tr>
      <tr><th scope="row">Tables and quotations</th><td>Comparison and context</td></tr>
    </tbody>
  </table>
</Prose>
Edit Prose in browser
02

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add Prose
lumen add Prose

API reference

Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.

AttributeValuesDefaultDescription
childrenrendered Markdown, CMS, or long-form HTMLrequiredApplies readable measure and typographic rhythm without changing the supplied semantics.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.

Web docsFull catalog