Pular para o conteúdo principal

Markdown Features

Docusaurus supports Markdown and a few additional features.

Front Matter​

Markdown documents have metadata at the top called Front Matter:

my-doc.md
---
id: my-doc-id
title: My document title
description: My document description
slug: /my-custom-url
---

## Markdown heading

Markdown text with [links](./hello.md)

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.

Images​

Regular Markdown images are supported.

You can use absolute paths to reference images in the static directory (static/img/docusaurus.png):

![Docusaurus logo](/img/docusaurus.png)

Docusaurus logo

You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:

![Docusaurus logo](./img/docusaurus.png)

Code Blocks​

Markdown code blocks are supported with Syntax highlighting.

```jsx title="src/components/HelloDocusaurus.js"
function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}
```
src/components/HelloDocusaurus.js
function HelloDocusaurus() {
  return <h1>Hello, Docusaurus!</h1>;
}

Admonitions​

Docusaurus has a special syntax to create admonitions and callouts:

:::note[Comentário]

Aqui vou colocar os meus pensamentos sobre o conteúdo.

:::

:::tip[Dica]

Alguma referência bacana que pode somar ao estudo.

:::

:::info[Informação]

Vou usar esse card para ir um pouco mais fundo em algum assunto apontando uma referência para estudo.

:::

:::warning[Atenção]

Indicação que o conteúdo tem natureza complexa.

:::

:::danger[Aviso]

Indicação que o assunto é sério ou grave.

:::
Comentário

Aqui vou colocar os meus pensamentos sobre o conteúdo.

Dica

Alguma referência bacana que pode somar ao estudo.

Informação

Vou usar esse card para ir um pouco mais fundo em algum assunto apontando uma referência para estudo. Também uso esse card para informar se a aula está em elaboração.

Atenção

Indicação que o conteúdo tem natureza complexa.

Aviso

Indicação que o assunto é sério ou grave.

MDX and React Components​

MDX can make your documentation more interactive and allows using any React components inside Markdown:

export const Highlight = ({children, color}) => (
  <span
    style={{
      backgroundColor: color,
      borderRadius: '20px',
      color: '#fff',
      padding: '10px',
      cursor: 'pointer',
    }}
    onClick={() => {
      alert(`You clicked the color ${color} with label ${children}`)
    }}>
    {children}
  </span>
);

This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !

This is <Highlight color="#1877F2">Facebook blue</Highlight> !

This is Docusaurus green !

This is Facebook blue !