Skip to main content

Note

Learn how to use a Note on your documentation

  1. Import relevant components from @primer/doctocat-nextjs:
import {Note} from '@primer/doctocat-nextjs'
  1. Use the components in your Markdown file, but ensure that you wrap the component in a div with the custom-component class. This will ensure that article formatting isn’t applied to the custom component.
Loading

Will render:

Example of a note

Variants

Use the variant option to change the style of the note. The default variant is info.

Loading

Will render:

Example of an info note
Example of a warning note