3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-16 00:06:11 +02:00
Code Issues Projects Releases Packages Wiki Activity

tutorial: explain .mdx better

Browse source
This commit is contained in:
sebastienlorber 2023-01-05 17:06:21 +01:00
parent 8ab654d028
commit bc680e280a
3 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/create-docusaurus/templates/shared/docs/tutorial-basics/create-a-page.mdx vendored
View file

@ -4,7 +4,7 @@ sidebar_position: 1
# Create a Page
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
Add **Markdown ([MDX](https://mdxjs.com/)) or React** files to `src/pages` to create a **standalone page**:
- `src/pages/index.js` → `localhost:3000/`
- `src/pages/foo.mdx` → `localhost:3000/foo`

8
packages/create-docusaurus/templates/shared/docs/tutorial-basics/markdown-features.mdx vendored
View file

@ -6,6 +6,14 @@ sidebar_position: 4
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
:::info
Docusaurus is based on **[MDX](https://mdxjs.com/)**. It allows you to use **[React and JSX](https://reactjs.org/docs/introducing-jsx.html)** in your Markdown documents.
You can use both `.md` and `.mdx` file extensions. We **recommend using the `.mdx` extension by default** and whenever using any advanced feature not included in [CommonMark](https://commonmark.org/): admonitions, tabs, React, JSX...
:::
## Front Matter
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):