Formatting cheat sheet¶

For full documentation visit zensical.org.

Examples¶

Note

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

Warning

This is a warning admonition. Be careful!

Click to expand for more info

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

Code blocks

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

greet("Python")

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

PythonRust

print("Hello from Python!")

println!("Hello from Rust!");

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

Here's a sentence with a footnote.¹

Hover it, to see a tooltip.