mydocs/docs/cheatsheets/index.md

icon
lucide/bookmark

Formatting cheat sheet

For full documentation visit zensical.org.

Examples

Admonitions

Go to documentation

!!! note

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

!!! warning

This is a **warning** admonition. Be careful!

Details

Go to documentation

??? info "Click to expand for more info"

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

Code Blocks

Go to documentation

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

greet("Python")

1. Go to documentation

   Code annotations allow to attach notes to lines of code.

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

Content tabs

Go to documentation

=== "Python"

``` python
print("Hello from Python!")
```

=== "Rust"

``` rs
println!("Hello from Rust!");
```

Diagrams

Go to documentation

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

Footnotes

Go to documentation

Here's a sentence with a footnote.¹

Hover it, to see a tooltip.

Formatting

Go to documentation

• ==This was marked (highlight)==
• ^^This was inserted (underline)^^
• This was deleted (strikethrough)
• H2O
• A^T^A
• ++ctrl+alt+del++

Icons, Emojis

Go to documentation

• ✨ :sparkles:
• 🚀 :rocket:
• 🎉 :tada:
• 📝 :memo:
• 👀 :eyes:

Task Lists

Go to documentation

• Install Zensical
• Configure zensical.toml
• Write amazing documentation
• Deploy anywhere

Tooltips

Go to documentation

Hover me

---

1. This is the footnote. ↩︎