write-api-reference

Generate Next.js API reference pages by creating focused MDX files from source code or user specifications. The output includes YAML frontmatter, usage examples, reference sections, and behavior notes for a single API surface.

Document Next.js file conventions in MDX by applying a category-based template to ensure consistency. This approach yields concise, example-driven pages aligned with specific API categories like components or directives.

Yes, you can create API docs for both components and directives. The documentation process applies to functions, file conventions, and config options, generating a dedicated MDX page for each API surface.

Structure YAML frontmatter for Next.js API documentation by including title, description, usage example, reference, behavior notes, and examples. This metadata header standardizes the generated MDX page layout.

Inconsistently documented API references delay integration and increase support costs. Creating focused, one-API reference pages solves this by ensuring documentation is concise, example-driven, and aligned to category templates.