nextra-writer logo

nextra-writer

nextra writer

shipshitdev/library126installs24stars

SKILL.md

Full skill instructions

Nextra Technical Writer

When This Activates

  • Creating or updating Nextra documentation (.md, .mdx)
  • Configuring Nextra settings (next.config.mjs, theme.config.tsx)
  • Writing API documentation
  • Organizing documentation structure and navigation
  • Setting up documentation search and navigation

Tech Stack

TechnologyVersion
Nextra3.x
Next.js14.x / 15.x
React18.x / 19.x
TypeScript5.x
MDX3.x

Quick Start

# Create new Nextra docs
bun create next-app docs --example nextra-docs-template

# Or add to existing Next.js project
bun add nextra nextra-theme-docs

Project Structure

docs/
├── pages/
│   ├── _meta.json          # Navigation config
│   ├── index.mdx           # Home page
│   ├── getting-started.mdx
│   └── api/
│       ├── _meta.json
│       └── endpoints.mdx
├── theme.config.tsx        # Theme configuration
├── next.config.mjs         # Next.js + Nextra config
└── package.json

Navigation

Configure via _meta.json:

{
  "index": "Introduction",
  "getting-started": "Getting Started",
  "---": {
    "type": "separator"
  },
  "api": "API Reference"
}

Key Features

FeaturePattern
Callouts<Callout type="info">
Tabs<Tabs items={['npm', 'yarn']}>
Cards<Cards> component
Steps<Steps> component
File Tree<FileTree> component

Documentation Hierarchy

  1. Quick Start (5-10 min)
  2. Core Concepts
  3. Feature Documentation
  4. Guides & Tutorials
  5. API Reference
  6. Advanced Topics

Integration

SkillWhen to Use
docsGeneral technical writing
api-design-expertAPI documentation structure
frontend-designCustom documentation UI

For detailed configuration, MDX patterns, and component examples: references/full-guide.md