mcpField
N
nextra-writer

nextra-writer

github.com/shipshitdevDevelopment38194 installsUpdated 2d ago
Repository

About nextra-writer

A documentation-writing skill for projects using Nextra, aimed at authors configuring or maintaining technical documentation. It covers MDX content, navigation structure, and common documentation components.

Key features

  1. 01Nextra documentation authoring
  2. 02Configuration guidance
  3. 03Navigation with _meta.json
  4. 04MDX component patterns
  5. 05Documentation hierarchy planning

Use cases

  1. 01Creating or updating Nextra docs
  2. 02Configuring documentation navigation
  3. 03Writing API documentation
  4. 04Organizing guides and reference pages

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/shipshitdev/skills --skill nextra-writer

After installing, type/nextra-writerin Claude Code to confirm it loaded.

Bundled filesplugin.jsonreferences/full-guide.md

Details

From the project README

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

Comments

Markdown supported