Skip to content

Get started

For full documentation visit zensical.org.

Commands

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

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

Code blocks
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: print("Hello, Python!").

Content tabs

Go to documentation

print("Hello from Python!")

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.1

Hover it, to see a tooltip.

Formatting

Go to documentation

  • This was marked (highlight)
  • This was inserted (underline)
  • This was deleted (strikethrough)
  • H2O
  • ATA
  • Ctrl+Alt+Del

Icons, Emojis

Go to documentation

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

Maths

Go to documentation

\[ \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

Go to documentation

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

Tooltips

Go to documentation

Hover me

  1. This is the footnote. ↩