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

Python
print("Hello from Python!")
Rust
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. ↩