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
- 01Nextra documentation authoring
- 02Configuration guidance
- 03Navigation with _meta.json
- 04MDX component patterns
- 05Documentation hierarchy planning
Use cases
- 01Creating or updating Nextra docs
- 02Configuring documentation navigation
- 03Writing API documentation
- 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-writerAfter installing, type/nextra-writerin Claude Code to confirm it loaded.
Bundled filesplugin.jsonreferences/full-guide.md
Details
From the project READMENextra 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
| Technology | Version |
|---|---|
| Nextra | 3.x |
| Next.js | 14.x / 15.x |
| React | 18.x / 19.x |
| TypeScript | 5.x |
| MDX | 3.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
| Feature | Pattern |
|---|---|
| Callouts | <Callout type="info"> |
| Tabs | <Tabs items={['npm', 'yarn']}> |
| Cards | <Cards> component |
| Steps | <Steps> component |
| File Tree | <FileTree> component |
Documentation Hierarchy
- Quick Start (5-10 min)
- Core Concepts
- Feature Documentation
- Guides & Tutorials
- API Reference
- Advanced Topics
Integration
| Skill | When to Use |
|---|---|
docs | General technical writing |
api-design-expert | API documentation structure |
frontend-design | Custom documentation UI |
For detailed configuration, MDX patterns, and component examples: references/full-guide.md
Comments
Markdown supported