Writing Documentation

$\LaTeX$ Equations with KaTeX

To see all the available $\LaTeX$ commands, see here.

Inline Equations

This is an example of an inline equation: $E=mc^2$.

This is an example of an inline equation: $E=mc^2$.

Block Equations

This is an example of a block equation:

$$ E=mc^2 $$

$$
E=mc^2
$$

Block Equations with Numbering

This is an example of a block equation with numbering:

$$ \begin{equation} E=mc^2 \end{equation} $$

$$
\begin{equation}
E=mc^2
\end{equation}
$$

Cross-Referencing Block Equations

See Equation 2 below.

Note

The equation numbering is not automatic for cross-referencing, unlike figures and tables.

$$ \begin{equation} E=mc^2 \end{equation} $$

See [Equation 2](#eq-label) below.

$$
\begin{equation}
E=mc^2
\end{equation}
$$
{ #eq:label }

Citations with BibTeX

Update docs/assets/bibliography.bib with your references.

This is an example of a citation¹.

This is an example of a citation[@ Serway2014].

Figures

Figures without Captions

![](https://picsum.photos/200/300)

Figures with Captions

Figure 1: This is the caption.

![This is the caption.](https://picsum.photos/200/300)

Cross-Referencing Figures with Captions

See Figure 2 below.

Figure 2: This is the caption.

See [](#fig-label) below.

![This is the caption.](https://picsum.photos/200/300){ #fig-label }

Diagrams with Mermaid

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

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

---

1. Raymond A. Serway and Jr. John W. Jewett. Physics for Scientists and Engineers with Modern Physics. Cengage Learning, 2014. ISBN 9781133954057. ↩