fumadocs-component-docs skill by theorcdev

Component Documentation Pattern

Create comprehensive documentation for 8-bit components following the standard structure.

Component Preview Structure

Wrap component examples in ComponentPreview with realistic data:

<ComponentPreview title="8-bit ComponentName component" name="component-name">
  <div className

Simple Component Example

For basic components like Button:

Complex Component Example

For components with multiple sub-components like Sheet:

Usage Section Pattern

Single import (simple components):

 
**Multiple imports** (complex components):
 
```mdx
```tsx
import {
  Sheet,
  SheetContent,
  SheetDescription,
  SheetHeader,
  SheetTitle,
  SheetTrigger,
} from "@/components/ui/8bit/sheet"

 
### Props Documentation
 
For components with props tables, use tables:
 
```mdx
### Props
 
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| variant | `string` | `"default"` | Visual style variant |
| size | `string` | `"default"` | Size of the button |
| asChild | `boolean` | `false` | Whether to merge props onto child |

Variant Examples

Show multiple variants in preview:

<ComponentPreview title="8-bit Health Bar component" name="health-bar">
  <div className="md:min-w-[300px] min-w-[200px] flex flex-col gap-8">
    <div>
      <p className="text-sm text-muted-foreground mb-2">
        Default health bar
      </p>
      <HealthBar value={75} />
    </div>
    <div>
      <p className="text-sm text-muted-foreground mb-2">
        Retro health bar
      </p>
      <HealthBar value={45} variant="retro" />
    </div>
  </div>
</ComponentPreview>

Copy Command Button

Place before ComponentPreview:

<div className="flex flex-col md:flex-row items-center justify-end gap-2 mb-2">
  <CopyCommandButton
    copyCommand="pnpm dlx shadcn@latest add @8bitcn/component-name"
    command="pnpm dlx shadcn@latest add @8bitcn/component-name"
  />
</div>

Key Principles

Preview first - Show component before explaining
Multiple variants - Demonstrate different prop combinations
Realistic data - Use meaningful values in examples
Import completeness - Include all used imports
Code block labels - Use ```tsx for TypeScript
8-bit components - Import from @/components/ui/8bit/
Consistent spacing - Use gap-4, p-4, mb-2 patterns

Reference Examples

content/docs/components/button.mdx - Simple component pattern
content/docs/components/health-bar.mdx - Variant demonstration
content/docs/components/sheet.mdx - Complex sub-component pattern