Skip to main contentGatsby theme Carbon

PageDescription

This is a <PageDescription> component. It is generally used for intro text at the top of the page using the type token expressive-heading-03.

Notes

For most pages, we recommend starting with a PageDescription followed by AnchorLinks if the content is long enough. Please note that this component, like all MDX components, is picky about white space, the line break above and below your content is required, and if you even have an extra space on the empty lines above/below it won’t render correctly. The text for the pages description should be consice – one sentence, or maybe two short ones at most.

Code

components/PageDescription/PageDescription.js
<PageDescription>
Lorem ipsum dolor sit amet, **consectetur adipiscing elit**, sed do eiusmod tempor _incididunt_ ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
</PageDescription>

Props

propertypropTyperequireddefaultdescription
childrennode