Markdown Features

Docusaurus supports Markdown and a few additional features.

Front Matter

Markdown documents have metadata at the top called Front Matter:

---
id: my-doc-id
title: My document title
description: My document description
keywords:
  - example
  - keyword
slug: /my-custom-url
---

## Markdown heading

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

Links

Regular Markdown links are supported, using url paths or relative file paths.

Note: Relative is preferred.

Let's see how to [update a page](/writing-docs/updating-docs.md).

Let's see how to [update a page](./updating-docs.md).

Result: Let's see how to update a page.

Files

Use the same Markdown syntax as links for files (such as PDFs).

[Wild Sage Node Manual](./pdfs/WSN_GS_V1.pdf)

Images

Regular Markdown images are supported.

  ![user interaction](../docs/about/images/SAGE_Interact.png)

Code Blocks

Markdown code blocks are supported with Syntax highlighting.

```python title="src/HelloSage.py"
def HelloSage():
  return 'Hello, Sage!'
```

def HelloSage():
  return 'Hello, Sage!'

Admonitions

In addition to the usual Markdown syntax (> some tip), 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

:::

:::note