Skip to content

Commit

Permalink
docs: clarify component naming for markdown import (#10545)
Browse files Browse the repository at this point in the history
* docs: clarify component naming for markdown import (#10542)

* Apply review suggestion

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

* Update website/docs/guides/markdown-features/markdown-features-react.mdx

---------

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
  • Loading branch information
jackrabbit128 and Josh-Cena authored Oct 2, 2024
1 parent 0794ebd commit 0657e58
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ This feature is experimental and might be subject to breaking API changes in the

## Importing Markdown {#importing-markdown}

You can use Markdown files as components and import them elsewhere, either in Markdown files or in React pages.
You can use Markdown files as components and import them elsewhere, either in Markdown files or in React pages. Each MDX file default-exports its page content as a React component. In the `import` statement, you can default-import this component with any name, but it must be capitalized following React's naming rules.

By convention, using the **`_` filename prefix** will not create any doc page and means the Markdown file is a **"partial"**, to be imported by other files.

Expand Down

0 comments on commit 0657e58

Please sign in to comment.