Tutorial basics
Markdown Features
Get MarkdownMarkdown Features
Docusaurus supports Markdown and a few additional features.
Front Matter
Markdown documents have metadata at the top called Front Matter:
// highlight-start
---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---
// highlight-end
## Markdown heading
Markdown text with [links](./hello.md)Links
Regular Markdown links are supported, using url paths or relative file paths.
Let's see how to [Create a page](/create-a-page).Let's see how to [Create a page](./create-a-page.md).Result: Let's see how to Create a page.
Code Blocks
Markdown code blocks are supported with Syntax highlighting.
```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
return <h1>Hello, Docusaurus!</h1>;
}
```function HelloDocusaurus() {
return <h1>Hello, Docusaurus!</h1>;
}Admonitions
Docusaurus has a special syntax to create admonitions and callouts:
:::tip My tip
Use this awesome feature option
:::
:::danger Take care
This action is dangerous
::::::tip My tip
Use this awesome feature option
:::
:::danger Take care
This action is dangerous
:::
MDX and React Components
MDX can make your documentation more interactive and allows using any React components inside Markdown:
import { Highlight } from '../../../src/components/mdx-highlight';
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
This is <Highlight color="#1877F2">Facebook blue</Highlight> !This is !
This is !