16aaf55a91
- Updated content collections to include new schemas for better document handling. - Added new documentation files for comparisons, customization, and internationalization. - Introduced a manual installation guide and improved markdown support. - Updated package.json with new dependencies for enhanced functionality. - Added new images for documentation and improved layout components for better user experience. - Adjusted TypeScript configurations for better path management.
42 lines
778 B
Plaintext
42 lines
778 B
Plaintext
---
|
|
title: MDX
|
|
description: Default MDX Components
|
|
index: true
|
|
---
|
|
|
|
## Usage
|
|
|
|
The default MDX components include Cards, Callouts, Code Blocks and Headings.
|
|
|
|
```ts
|
|
import defaultMdxComponents from 'fumadocs-ui/mdx';
|
|
```
|
|
|
|
### Relative Link
|
|
|
|
To support links with relative file path in `href`, override the default `a` component with:
|
|
|
|
```tsx
|
|
import { createRelativeLink } from 'fumadocs-ui/mdx';
|
|
import { source } from '@/lib/source';
|
|
|
|
const page = source.getPage(['...']);
|
|
|
|
return (
|
|
<MdxContent
|
|
components={{
|
|
// override the `a` tag
|
|
a: createRelativeLink(source, page),
|
|
}}
|
|
/>
|
|
);
|
|
```
|
|
|
|
```mdx
|
|
[My Link](./file.mdx)
|
|
```
|
|
|
|
[Example: `../(integrations)/open-graph.mdx`](<../(integrations)/open-graph.mdx>)
|
|
|
|
<Callout type="warn">Server Component only.</Callout>
|