🎯

fumadocs-mdx-structure

🎯Skill

from theorcdev/8bitcn-ui

VibeIndex|
What it does

fumadocs-mdx-structure skill from theorcdev/8bitcn-ui

πŸ“¦

Part of

theorcdev/8bitcn-ui(23 items)

fumadocs-mdx-structure

Installation

πŸ“‹ No install commands found in docs. Showing default command. Check GitHub for actual instructions.
Quick InstallInstall with npx
npx skills add theorcdev/8bitcn-ui --skill fumadocs-mdx-structure
33Installs
1,576
-
Last UpdatedJan 22, 2026

Skill Details

SKILL.md

Create MDX documentation files with proper frontmatter, imports, and component integration. Apply when creating or updating Fumadocs documentation pages in content/docs/.

Fumadocs MDX Structure

Create well-structured MDX documentation files for 8-bit components following the established patterns.

Frontmatter Pattern

```mdx

---

title: Component Name

description: Brief description of the 8-bit component.

---

```

Import Pattern

All documentation files require these imports:

```mdx

import { ComponentName } from "@/components/ui/8bit/component-name";

import CopyCommandButton from "@/components/copy-command-button";

import InstallationCommands from "@/components/installation-commands";

import ComponentPreview from "@/components/component-preview";

```

Copy Command Button

Place immediately after frontmatter:

```mdx

copyCommand="pnpm dlx shadcn@latest add @8bitcn/component-name"

command="pnpm dlx shadcn@latest add @8bitcn/component-name"

/>

```

Component Preview

Wrap component examples:

```mdx

Example

```

Installation Section

```mdx

Installation

---

```

Usage Section

```mdx

Usage

---

```tsx

import { ComponentName } from "@/components/ui/8bit/component-name"

```

```tsx

Example

```

```

Complete Example

```mdx

---

title: Button

description: Displays an 8-bit button component.

---

import { Button } from "@/components/ui/8bit/button";

import CopyCommandButton from "@/components/copy-command-button";

import InstallationCommands from "@/components/installation-commands";

import ComponentPreview from "@/components/component-preview";

copyCommand="pnpm dlx shadcn@latest add @8bitcn/button"

command="pnpm dlx shadcn@latest add @8bitcn/button"

/>

Installation

---

Usage

---

```tsx

import { Button } from "@/components/ui/8bit/button"

```

```tsx

```

```

Key Principles

  1. Frontmatter required - title and description are mandatory
  2. Import order - Component β†’ utilities β†’ UI components
  3. Copy button - Place before ComponentPreview
  4. ComponentPreview - Use for all component examples
  5. Code blocks - Use ```tsx for TypeScript examples
  6. Section separators - Use --- after headings
  7. 8-bit imports - Use @/components/ui/8bit/ path

File Location

Place documentation files in:

  • content/docs/components/component-name.mdx for components
  • content/docs/blocks/category/block-name.mdx for blocks