skills.rest
vercel
vercelOFFICIAL
Explore all skills by this author →
Website𝕏@vercelGitHub

write-api-reference

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

142k|31.7k|Updated Oct 5, 2016
Search Tags:#automation#documentation#api#next.js#reference#frontmatter#mdx
One-click install
npx skills add https://github.com/vercel/next.js --skill write-api-reference
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-api-reference
Source: https://github.com/vercel/next.js/tree/main/.agents/skills/write-api-reference
Command: npx skills add https://github.com/vercel/next.js --skill write-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of structured API reference documentation for Next.js APIs, reducing manual drafting time.

Core Features & Use Cases

  • Documents a single API surface with a concise, example-driven page.
  • Supports functions, components, file conventions, directives, and config options.
  • Produces a .mdx page with YAML frontmatter, usage example, reference, behavior notes, and examples.
  • Use cases include drafting new API docs, updating references for API changes, and standardizing formatting.

Quick Start

Provide a ready-to-publish API reference page for a chosen API surface in Next.js.

Frequently Asked Questions about write-api-reference

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

FAQPage Schema
How do I auto-generate API reference documentation for Next.js?▼

Auto-generate API reference documentation by processing Next.js API sources or specifications to output structured MDX pages with YAML frontmatter, usage examples, and behavior notes.

What types of Next.js API surfaces can be documented using automation?▼

Automated documentation supports Next.js functions, components, file conventions, directives, and config options.

Does the generated API reference page include MDX and frontmatter formatting?▼

Yes, generated API reference pages output MDX files equipped with YAML frontmatter containing the API name and description.

Can I use this to update existing docs when an API changes in Next.js?▼

Yes, you can use this automation to update references for API changes by applying existing docs or user specifications to standardize formatting.

What sections are included in the structured template for the API reference?▼

The structured template includes sections for usage examples, reference details, behavior notes, and additional examples.

Related Skills

Explore More Software Engineering Skills→
nashirabbashnashirabbash

write-api-reference

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

Community
Advanced
WellDunDunWellDunDun

mintlify

Automate Mintlify documentation site creation and maintenance with MDX and docs.json.

Community
Intermediate
idealjsidealjs
5

create-component-nextjs-page

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

Official
Intermediate
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate