Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: clarify component naming for markdown import #10545

Merged
merged 3 commits into from
Oct 2, 2024
Merged

docs: clarify component naming for markdown import #10545

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fc0265
docs: clarify component naming for markdown import (#10542)
jackrabbit128 Oct 2, 2024
b9edccc
Apply review suggestion
jackrabbit128 Oct 2, 2024
81e3d8e
Update website/docs/guides/markdown-features/markdown-features-react.mdx
Josh-Cena Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/guides/markdown-features/markdown-features-react.mdx
View file
Open in desktop
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