Add notes on how to type props and components

karlhorky · web-flow · commit 95ba33e154cb · 2024-07-12T11:48:38.000+02:00
Closes GH-2510. Reviewed-by: Titus Wormer <tituswormer@gmail.com>
diff --git a/docs/docs/using-mdx.mdx b/docs/docs/using-mdx.mdx
@@ -1,3 +1,5 @@
+import {Note} from '../_component/note.jsx'
+
 export const info = {
   author: [
     {github: 'wooorm', name: 'Titus Wormer', twitter: 'wooorm'}
@@ -206,6 +208,13 @@ console.log(React.createElement(Example, {name: 'Venus', year: 2021}))
 console.log(<Example name="Mars" year={2022} />)
 ```
 
+<Note type="info">
+  **Note**:
+  Users of the MDX VS Code extension can add type
+  checking of `props` with a JSDoc comment.
+  See [`mdx-js/mdx-analyzer`][mdx-analyzer] for more info.
+</Note>
+
 ### Components
 
 There is one special prop: `components`.
@@ -383,6 +392,13 @@ because in JSX syntax `a` is a literal tag name.
 The third link (`#charlie`) is dashed and tomato,
 as in JSX syntax `Link` is a reference.
 
+<Note type="info">
+  **Note**:
+  Users of the MDX VS Code extension can add type
+  checking of provided and passed components with a JSDoc comment.
+  See [`mdx-js/mdx-analyzer`][mdx-analyzer] for more info.
+</Note>
+
 ### Layout
 
 There is one special component: the layout.
@@ -592,6 +608,8 @@ providers: pass components explicitly.
 
 [what]: /docs/what-is-mdx/
 
+[mdx-analyzer]: https://github.com/mdx-js/mdx-analyzer
+
 [mdx-react]: /packages/react/
 
 [mdx-preact]: /packages/preact/
