You're viewing the changeset-release/main deployment.
View on main →

Keypoints

Keypoints component for highlighting main article topics

storybook

Summary

Highlights key takeaways as a visually distinct bulleted list.

Can be used after Intro, to list main points the article covers: one bullet per KeypointsItem.

Keypoints composes a shadcn Card, while keeping a native section, heading and bulleted list. Its MDX API stays the same.

To install the standalone block in a shadcn project:

pnpm dlx shadcn@latest add pmndrs/docs/keypoints

The registry installs card using your project's shadcn base and preset. It also resolves an explicit, release-tagged pmndrs/design-system/theme dependency, bringing the design system's palette and mono font. Card alone does not install that theme, and Keypoints needs no custom surface utility.

<Keypoints title="What you'll learn">
  <KeypointsItem>First item</KeypointsItem>
  <KeypointsItem>Second **item**</KeypointsItem>
</Keypoints>

result:

What you'll learn

  • First item
  • Second item

docs/authoring/keypoints.mdx

Edit this page