Skip to content

Commit b0ce092

Browse files
Copilothuangyiirene
andcommitted
Add documentation about available MDX components
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 5b4ca5f commit b0ce092

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

example/content/docs/configuration.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,18 @@ description: Page description for SEO
9797
- **title**: Page title (required)
9898
- **description**: Page description for SEO (required)
9999

100+
### Available Components
101+
102+
ObjectDocs provides Fumadocs UI components globally. No imports needed:
103+
104+
- **Callout**: `<Callout type="info|warn|error">...</Callout>`
105+
- **Cards/Card**: `<Cards><Card title="..." icon="...">...</Card></Cards>`
106+
- **Steps/Step**: `<Steps><Step>...</Step></Steps>`
107+
- **Tabs/Tab**: For tabbed content
108+
109+
Example:
110+
111+
```mdx
100112
<Callout type="warn">
101113
Always include both `title` and `description` in your frontmatter for proper SEO and navigation.
102114
</Callout>

example/content/docs/getting-started.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ pnpm dev
8080

8181
Visit [http://localhost:7777](http://localhost:7777) to see your site.
8282

83+
{/* Note: Callout, Cards, Steps and other Fumadocs components are globally available */}
8384
<Callout type="info">
8485
The development server includes hot reload, so changes to your content will be reflected immediately.
8586
</Callout>

example/content/docs/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ ObjectDocs is a next-generation documentation engine built on:
1717

1818
## Key Features
1919

20+
{/* ObjectDocs provides Fumadocs components globally - no imports needed */}
2021
<Cards>
2122
<Card title="Metadata-Driven" icon="settings">
2223
Control navigation, sidebars, and SEO entirely via JSON configuration files.

0 commit comments

Comments
 (0)