Get started¶

Examples¶

Admonitions¶

Note

This is a note admonition. Use it to provide helpful information.

Warning

This is a warning admonition. Be careful!

Inline blocks¶¶

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Details¶

Click to expand for more info

This content is hidden until you click to expand it. Great for FAQs or long explanations.

Code Blocks¶

Code blocks

def greet(name):
    print(f"Hello, {name}!") # (1)!

greet("Python")

fibonacci.rs
fn fib (n: i32) -> i32 {
    if n <= 0 {
        return 0;
    } else if n == 1 {
        return 1;
    } else {
        return fib (n-1) + fib (n-2);
    }
}

fn main() {
    for int in 0..15 {
        println! ( "fibonacci ({}) => {}", int, fib(int));
    }
}

Go to documentation

Code annotations allow to attach notes to lines of code.

Code can also be highlighted inline: print("Hello, Python!").

Content tabs¶

PythonRust

print("Hello from Python!")

println!("Hello from Rust!");

Example

Unordered ListOrdered List

* Sed sagittis eleifend rutrum
* Donec vitae suscipit est
* Nulla tempor lobortis orci

1. Sed sagittis eleifend rutrum
2. Donec vitae suscipit est
3. Nulla tempor lobortis orci

Diagrams¶

graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];

sankey

%% source,target,value
Electricity grid,Over generation / exports,104.453
Electricity grid,Heating and cooling - homes,113.726
Electricity grid,H2 conversion,27.14

Footnotes¶

Here's a sentence with a footnote.¹

Hover it, to see a tooltip.

Formatting¶

This was marked (highlight)
This was inserted (underline)
~~This was deleted (strikethrough)~~
H₂O
A^TA
Ctrl+Alt+Del

Icons, Emojis¶

:sparkles:
:rocket:
:tada:
:memo:
:eyes:

Maths¶

\[ \cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} \]

Needs configuration

Note that MathJax is included via a script tag on this page and is not configured in the generated default configuration to avoid including it in a pages that do not need it. See the documentation for details on how to configure it on all your pages if they are more Maths-heavy than these simple starter pages.

Task Lists¶

Install Zensical
Configure zensical.toml
Write amazing documentation
Deploy anywhere

Tooltips¶

Hover me

This is the footnote. ↩