mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 18:35:07 +03:00
Charis
dbbbc20d63
We allow fetching external data in CodeSamples into a MDX environment, so we have to be careful about preventing code execution. Current checks: - External data is inserted as a code block (via the AST, not direct string manipulation), so it is escaped. Added two new layers of checks: - Allow-list of organizations, currently set to Supabase-only - Only allow immutable commit references
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.