MkDocs

MkDocs components

Reusable components available in every MDX page.

These components are registered in press.config.tsx and are available without imports.

Cards

Callouts

Information

Add useful context without interrupting the main flow.

Keep it useful

Use a callout for information readers may otherwise miss.

Ready to ship

Callouts support success, error, warning, idea, and custom icons.

Guided steps

Create the page

Add an .mdx file under content/.

Add navigation metadata

Add the page slug to the nearest meta.json file.

Tabs

pnpm install
pnpm dev

Accordions

File trees

index.mdx
components.mdx
meta.json

API properties

Prop

Type

Video

Use YoutubeVideo without importing it inside MDX:

<YoutubeVideo url="https://www.youtube.com/embed/VIDEO_ID" />

Last updated on

On this page