Get started🪶

For full documentation visit zensical.org.

Commands🪶

zensical new - Create a new project
zensical serve - Start local web server
zensical build - Build your site

Examples🪶

Admonitions🪶

Note

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

Warning

This is a warning admonition. Be careful!

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")

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

Python

print("Hello from Python!")

Rust

println!("Hello from Rust!");

Diagrams🪶

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

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:
:eigenote: :eigenote:
:ember: :ember:
:favicon: :favicon:

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