mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 18:05:11 +03:00
Ivan VasilovandCharis Lam
70388e50bb
* Fix the error for babel/preset-typescript in docs. * Unfix the version. * Try using amaro for type stripping. * Run prettier after stripping types. * Fix tests. --------- Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
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.