Skip to content

Commit

Permalink
add real world component example
Browse files Browse the repository at this point in the history
  • Loading branch information
souporserious committed Oct 13, 2024
1 parent 3b844d5 commit c5fcba6
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions apps/site/docs/02.getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { APIReference } from 'renoun/components'

export const metadata = {
title: 'Getting Started',
}
Expand Down Expand Up @@ -167,13 +169,19 @@ Here we define a schema for the front matter of our MDX files and use it to vali

## Enhancing with Components

renoun provides several built-in components to enhance your documentation. For example, you can use the `PackageInstall` component to display installation instructions for a package:
The renoun toolkit provides several built-in components to enhance your documentation. For example, you can use the `APIReference` component to easily document your APIs:

```tsx allowErrors
<PackageInstall packages={['renoun']} />
```mdx
import { APIReference } from 'renoun/components'

<APIReference source="components/Card.tsx" />
```

This will render an interactive component showing installation commands for different package managers. Explore more [components](/components) to enhance your documentation.
<Preview>
<APIReference source="components/Card.tsx" />
</Preview>

Explore more [components](/components) to enhance your documentation.

## Conclusion

Expand Down

0 comments on commit c5fcba6

Please sign in to comment.