Guide: Advanced Markdown

Authors	Kai Berszin
Last Updated	10/12/2025, 12:48:54 PM
Last Author	Kai Berszin

Scope

This article describes various advanced markdown features, also including custom features of this docusaurus instance.
For a basic introduction to markdown refer to the Basic Markdown Guide.

Math

Math equations can be embedded into documentations with a latex-like syntax. A full overview of this feature is described in this guide.

Similar to latex, inline math equations can be written embedded inside a single $ block.

Given the simple equation $f(x)=a\cdot x+b\cdot x^2 + c$, one may find the zero points using the abc-formular Given the simple equation $f(x)=a\cdot x+b\cdot x^2 + c$, one may find the zero points using the abc-formular

Block equations are embedded into $$ and also support whole begin blocks.

$$
\begin{align}
  \nabla\cdot E  &= \frac{\rho}{\epsilon_0} \\
  \nabla\cdot B  &= 0 \\
  \nabla\times E &= - \frac{\partial B}{\partial t} \\
  \nabla\times B &= \mu_0(J + \epsilon_0\frac{\partial E}{\partial t}) \\
\end{align}
$$

$$\begin{align} \nabla\cdot E &= \frac{\rho}{\epsilon_0} \\ \nabla\cdot B &= 0 \\ \nabla\times E &= - \frac{\partial B}{\partial t} \\ \nabla\times B &= \mu_0(J + \epsilon_0\frac{\partial E}{\partial t}) \\ \end{align}$$

Diagrams

Diagrams can be rendered using Mermaid in a code block.
A complete overview of this feature is given in this guide, a general overview over different graphs and how to use them is given in this Mermaid Guide.

Flow chart

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```

Gantt

```mermaid
gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram to mermaid
excludes weekdays 2014-01-10

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2              :         des4, after des3, 5d
```

SAGE specific tayloring

The SAGE documentation deploys a custom tayloring plugin, allowing for some documentation specific features such as the index table at the beginning of this page.
For more information please refer to the SAGE Tayloring Plugin.