Planum Docs
LINKS
  • Home
  • GitHub Repository
DOCS
  • Installation Guide
  • Getting Started
  • Writing your First Doc
  • Configuration

    • App Configuration
    • Sidebar Configuration
  • Deploying to Production
    • Markdown Cheat Sheet
    • Using Math in Planum
v2.0.0 Docs

Using Math in Planum

Planum Docs support rendering math equations using KaTeX. A guide to KaTeX can be found at https://katex.org/docs/supported.html.

Examples

Use single $ for inline math and $$ for block math.

Pythagoran theorem is $a^2 + b^2 = c^2$.

Bayes theorem:

$$P(A | B) = (P(B | A)P(A)) / P(B)$$

Pythagoran theorem is a2+b2=c2a^2 + b^2 = c^2.

Bayes theorem:

P(A∣B)=(P(B∣A)P(A))/P(B)P(A | B) = (P(B | A)P(A)) / P(B)

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
(∑k=1nakbk)2≤(∑k=1nak2)(∑k=1nbk2)\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)

$$
\begin{CD}
A @>a>> B \\
@VbVV @AAcA \\
C @= D
\end{CD}
$$
A→aBb↓↑cC=D \begin{CD} A @>a>> B \\ @VbVV @AAcA \\ C @= D \end{CD}

$$
x = \begin{cases}
   a &\text{if } b \\
   c &\text{if } d
\end{cases}
$$
x={aif bcif d x = \begin{cases} a &\text{if } b \\ c &\text{if } d \end{cases}

$$\textcolor{green}{F=ma}$$
$$\fcolorbox{red}{teal}{F=ma}$$
$$\fcolorbox{red}{yellow}{\textcolor{green}{F=ma}}$$
F=ma\textcolor{green}{F=ma}
F=ma\fcolorbox{red}{teal}{F=ma}
F=ma\fcolorbox{red}{yellow}{\textcolor{green}{F=ma}}

Limitations

HTML features of KaTeX are not fully supported in Planum Docs. There is limited support for using \url and \href commands.

TABLE OF CONTENTS
  • Examples
  • Limitations