Reference
Reference is used to create the Reference List. These Reference Links are rendered at the end of the Root Component.
💡
ReferenceList is required to render the reference list.
Props
Prop | Description | Required |
---|---|---|
title | Title for the reference, if needed | false |
link | The external link to the reference | true |
children | Any valid JSX element | true |
className | classNames for the Header component | false |
style | CSS styles | false |
Sample Usage
<Suchi.Root accentColor="orangered" className="article_wrapper my-8" style={{ padding: "16px"}}>
<Suchi.Index />
<Suchi.Header className="my-4 text-3xl font-bold">Building a NPM Libray</Suchi.Header>
<Suchi.Section className="my-4">
<Suchi.SectionHeader className="text-2xl">Project Setup</SectionHeader>
<Suchi.Content className="py-4">
<Suchi.Reference
title="AWS Nitro Enclave"
link="https://aws.amazon.com/ec2/nitro/nitro-enclaves/"
className="underline underline-offset-2"
>
AWS Nitro Enclaves
</Suchi.Reference>
</Suchi.Content>
<Suchi.Section>
<Suchi.ReferenceList /> // Required to render all References
</Suchi.Root>