skills.rest
nashirabbash
nashirabbashCOMMUNITY
Explore all skills by this author →
GitHub

write-api-reference

Generate MDX API reference pages for Next.js APIs from source or specifications.

Updated Mar 30, 2026
Search Tags:#templates#documentation#markdown#nextjs#mdx#api-reference
One-click install
npx skills add https://github.com/nashirabbash/autorepychatbot --skill write-api-reference-nashirabbash
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-api-reference
Source: https://github.com/nashirabbash/autorepychatbot/tree/main/.agents/skills/write-api-reference
Command: npx skills add https://github.com/nashirabbash/autorepychatbot --skill write-api-reference-nashirabbash

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produce consistent, ready-to-publish API reference documentation for Next.js APIs by auto-generating MDX pages from source or specifications.

Core Features & Use Cases

  • Template-driven API reference pages for functions, components, file conventions, directives, and config options.
  • Input-flexible: derives content from Next.js source, existing docs, or user-provided specs.
  • Output-ready: generates a markdown (.mdx) page with YAML frontmatter, usage examples, reference sections, behavior notes, and examples.

Quick Start

Provide a complete MDX API reference page for a Next.js API surface using the given input sources.

Frequently Asked Questions about write-api-reference

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate MDX API reference pages for Next.js components?▼

Generate MDX API reference pages for Next.js by using a structured template that produces markdown with YAML frontmatter, usage examples, reference sections, behavior notes, and version history from your source code.

What is the best way to document Next.js file conventions and directives?▼

Document Next.js file conventions and directives by drafting concise MDX pages that consolidate behavior notes, usage examples, and structured reference sections directly from existing docs or user specifications.

Can I create Next.js API docs from source code without writing markdown manually?▼

Yes, you can create Next.js API docs directly from source code by auto-generating ready-to-publish markdown pages that include YAML frontmatter and structured examples without manual formatting.

Does this approach support documenting Next.js config options and functions?▼

Yes, this approach supports documenting Next.js config options and functions by deriving content from source or specs to produce consistent, template-driven MDX API reference pages.

How do I structure behavior notes and examples for an API reference page?▼

Structure behavior notes and examples for an API reference page by following a markdown template that organizes YAML frontmatter, usage examples, reference sections, and version history into a single MDX file.

Related Skills

Explore More Software Engineering Skills→
villa1villa1

write-api-reference

Generates MDX API reference pages for Next.js components, functions, directives, and more.

Community
Advanced
idealjsidealjs
5

create-component-nextjs-page

Create Next.js MDX/TSX component demo pages with variants and visual regression tests.

Official
Intermediate
vercelvercel
141.7k

write-api-reference

Generate structured MDX API reference pages for Next.js APIs.

Official
Intermediate
fabioc-alohafabioc-aloha
1

API Documentation Skill

Scaffold technical documentation projects with templates for API endpoints and guides.

Community
Intermediate