mirror of
https://github.com/supabase/supabase.git
synced 2026-06-28 19:39:19 -04:00
Chris Chinchilla
04501d2f85
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Behavior Changes** * Partial directives now render unprovided variables as empty strings instead of throwing validation errors * Escaped placeholders (preceded by backslash) are preserved and not substituted * Unused provided variables are silently ignored * **Tests** * Updated test coverage to validate the new permissive variable substitution behavior and removed prior error-focused assertions <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.