Skip to content

docs(v2): add documentation about importing markdown #4958

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

Merged
slorber merged 3 commits into from
Jun 15, 2021
Merged

docs(v2): add documentation about importing markdown #4958

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb7c1b3
Add documentation about importing markdown
Josh-Cena Jun 14, 2021
e0b9db3
Update website/docs/guides/markdown-features/markdown-features-react.mdx
slorber Jun 15, 2021
d4d95fb
Run prettier
Josh-Cena Jun 15, 2021
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
30 changes: 30 additions & 0 deletions 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 @@ -7,6 +7,8 @@ slug: /markdown-features/react

import BrowserWindow from '@site/src/components/BrowserWindow';

## Using JSX in Markdown {#using-jsx-in-markdown}

Docusaurus has built-in support for [MDX](https://mdxjs.com/), which allows you to write JSX within your Markdown files and render them as React components.

:::note
Expand Down Expand Up @@ -69,3 +71,31 @@ You can also import your own components defined in other files or third-party co
Since all doc files are parsed using MDX, any HTML is treated as JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects. This behavior is different from Docusaurus 1. See also [Migrating from v1 to v2](../../migration/migration-manual.md#convert-style-attributes-to-style-objects-in-mdx).

:::

## Importing Markdown {#importing-markdown}

You can use Markdown files as components and import them elsewhere, either in Markdown files or in React pages. Below we are importing from [another file](./markdown-features-intro.mdx) and inserting it as a component.

```jsx
import Intro from './markdown-features-intro.mdx';

<Intro />;
```

<BrowserWindow url="http://localhost:3000">

import Intro from './markdown-features-intro.mdx';

<Intro />

</BrowserWindow>

<br />

This way, you can reuse contents among multiple pages and avoid duplicating materials.
Comment thread
slorber marked this conversation as resolved.

:::caution

The table-of-contents does not currently contain the imported Markdown headings. This is a technical limitation that we are trying to solve ([issue](https://github.com/facebook/docusaurus/issues/3915)).

:::