Skip to content

Typography

Prose

Styles rendered Markdown and other long-form HTML: docs, posts and guides.

import { Prose } from '@jsonresume/ui'Source(opens in a new tab)

Examples

Article

Why JSON?

We believe the strengths of the JSON format make it a good fit for resumes. It's lightweight, easy to use and well specified.

  • Write it once, render it in any theme.
  • Validate it with resume validate.
For developers, by developers.
prose/article.tsx
import { Prose } from '@jsonresume/ui';

export default function ProseArticle() {
  return (
    <Prose>
      <h2>Why JSON?</h2>
      <p>
        We believe the strengths of the JSON format make it a good fit for
        resumes. It&apos;s lightweight, easy to use and{' '}
        <a href="https://jsonresume.org/schema">well specified</a>.
      </p>
      <ul>
        <li>Write it once, render it in any theme.</li>
        <li>
          Validate it with <code>resume validate</code>.
        </li>
      </ul>
      <blockquote>For developers, by developers.</blockquote>
    </Prose>
  );
}

Accessibility

  • Keeps a 72ch measure so lines stay readable.

Props

<Prose>

Also accepts the attributes of the element Prose renders.
PropTypeDefaultDescription
asChildbooleanfalseRender as the child element (e.g. <article>) instead of a <div>.