Skip to main content

Markdown Features

Toucaan 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/redgoose.svg):

![Toucaan logo](/img/redgoose.svg)

Toucaan logo

You can reference images relative to the current file as well, as shown in the extra guides.

Code Blocks

Markdown code blocks are supported with Syntax highlighting.

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

Admonitions

Toucaan has a special syntax to create admonitions and callouts:

:::tip My tip

Use this awesome feature option

:::

:::danger Take care

This action is dangerous

:::
My tip

Use this awesome feature option

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:

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">Toucaan green</Highlight> !

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

This is Toucaan green !

This is Red Goose blue !