Files
supabase/apps/docs/features/directives
Charis 40c9bee53e feat(docs): improve error messages for Partials directive (#42079)
- Add validation for missing required variables
- Add validation for unexpected variables
- Provide detailed error messages showing expected vs provided variables
- Include partial path in error messages for better debugging
- Add comprehensive tests for new error scenarios

Error messages now clearly indicate:
- Which variables are missing
- Which variables are unexpected
- What variables were expected vs provided

Co-authored-by: Claude <noreply@anthropic.com>
2026-01-23 11:52:54 +11:00
..

Directives

Directives are a custom feature of the Supabase docs content system, which allows you to extend MDX to provide custom functionality.

Why not a React component?

MDX supports React components, and that is the preferred way to add new features. If your use case is supported by a React component alone, use that instead.

Custom directives are used to implement features that need low-level parse or compile-time control over the MDX AST.

Syntax

We reserve a special syntax for directives, which start with a $ sign. For example:

<$CodeSample />

This syntax was chosen because it is both:

  • Sufficiently standard to be supported by MDX parsers without needing to build a custom extension.
  • Sufficiently uncommon to avoid collisions with other React components used in docs.