3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-28 17:57:48 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: clarify component naming for markdown import (#10545)

Browse source 
* 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>
This commit is contained in:
jackrabbit128 2024-10-02 23:45:11 +02:00 • committed by GitHub
parent 0794ebdd18
commit 0657e5806c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
website/docs/guides/markdown-features/markdown-features-react.mdx
View file

@ -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.