Markdown

Definition Lists

First Term
This is the definition of the first term.
Second Term
This is one definition of the second term.
This is another definition of the second term.
First Term
: This is the definition of the first term.

Second Term
: This is one definition of the second term.
: This is another definition of the second term.

Admonitions

A note

Stay hydrated~

{{ admonition(type="note", title="A note", text="Stay [hydrated]https://wikipedia.org/wiki/Water~") }}
A tip

Stay hydrated~

{{ admonition(type="tip", title="A tip", text="Stay [hydrated]https://wikipedia.org/wiki/Water~") }}
A info

Stay hydrated~

{{ admonition(type="info", title="A info", text="Stay [hydrated]https://wikipedia.org/wiki/Water~") }}
A warning

Stay hydrated~

{{ admonition(type="warning", title="A warning", text="Stay [hydrated]https://wikipedia.org/wiki/Water~") }}
A danger

Stay hydrated~

{{ admonition(type="danger", title="A danger", text="Stay [hydrated]https://wikipedia.org/wiki/Water~") }}

Aside

{{ aside(text="This is a *sidenote*") }}

Syntax highlighting

1```rust,name=main.rs,linenos
2fn foo() {
3 println!("bar");
4}
5```

Wide container

Look at these adorable creatures!

{% wide_container() %}
...
{% end %}

Taxonomies

[taxonomies]
tags = ["components", "boards", "chips", "sensors"]

Spoiler

Did you know that Snape ?

{{ spoiler(text="text to hide") }}

Footnotes

Here's a simple footnote,1 and here's a longer one.2

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote.

[^bignote]: Here's one with multiple paragraphs and code.

    `{ my code }`

    Indent paragraphs to include them in the footnote.

LaTeX expressions

$ \sin(x) = \sum_{n=0}^{\infty} \frac{(-1)^n}{(2n + 1)!} x^{2n + 1} $

$ expr $

\[ r = \frac{\sum_{i=1}^{n}(x_i - \bar{x})(y_i - \bar{y})}{\sqrt{\sum_{i=1}^{n}(x_i - \bar{x})^2}\sqrt{\sum_{i=1}^{n}(y_i - \bar{y})^2}} \]

\\[ expr \\]

Enable in your frontmatter:

[extra]
katex = true

Mermaid diagrams

    classDiagram
    class CognitiveDistortions {
        +AllOrNothingThinking()
        +Overgeneralization()
        +MentalFilter()
        +JumpingToConclusions()
    }
    class AllOrNothingThinking {
        +SeeInExtremes()
    }
    class Overgeneralization {
        +GeneralizeFromSingle()
    }
    class MentalFilter {
        +FocusOnNegative()
    }
    class JumpingToConclusions {
        +MakeAssumptions()
    }
    CognitiveDistortions *-- AllOrNothingThinking
    CognitiveDistortions *-- Overgeneralization
    CognitiveDistortions *-- MentalFilter
    CognitiveDistortions *-- JumpingToConclusions
+++
[extra]
mermaid = true
+++

{% mermaid(full_width=true) %}
...
{% end %}

Shortcodes

  1. This is the first footnote.

  2. Here's one with multiple paragraphs and code.

    { my code }

    Indent paragraphs to include them in the footnote.